Page MenuHomePhabricator

csharp: Document eina_value.cs
ClosedPublic

Authored by lauromoura on Tue, Oct 8, 5:38 PM.

Details

Summary

Added more docs alongside the since information.

For items that should be skipped from the end user of the binding but
must stay public for generated code,
EditorBrowsable(EditorBrowsableState.Never) was used.

ref T8293

Diff Detail

Repository
rEFL core/efl
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
lauromoura created this revision.Tue, Oct 8, 5:38 PM
lauromoura requested review of this revision.Tue, Oct 8, 5:38 PM
segfaultxavi requested changes to this revision.Wed, Oct 9, 1:01 AM

General comments:

  • Missing <param> and <returns> docs. I know adding ALL of them is a lot of work, but at least some of them are necessary for the user, for example, the return values of Compare or Set methods.
  • Copy and paste woes: Sets the contained valued. -> Sets the contained value.
  • Copy and paste woes: an Value -> a Value
src/bindings/mono/eina_mono/eina_value.cs
1137–1147

Different how? I think this should be clarified... at least I do not know what optionals are and how they relate to Eina.Value.

2070–2074

Do not use acronyms.

2570–2576

What is the "target" value and what is an "optional"?

2891

What does the returned bool mean?

3007

whether this

3071

different from

3086

greater

This revision now requires changes to proceed.Wed, Oct 9, 1:01 AM
lauromoura updated this revision to Diff 25985.Wed, Oct 9, 1:46 PM

Update after Xavi's comment.

lauromoura updated this revision to Diff 25986.Wed, Oct 9, 1:58 PM
lauromoura marked 4 inline comments as done.

There was a rogue this

lauromoura marked 3 inline comments as done.Wed, Oct 9, 2:00 PM
lauromoura updated this revision to Diff 25988.Wed, Oct 9, 2:50 PM

Somehow the test was flaky. Removing it.

A few typos

segfaultxavi accepted this revision.Thu, Oct 10, 1:18 AM

Just fixed some typos.

This revision is now accepted and ready to land.Thu, Oct 10, 1:18 AM
This revision was automatically updated to reflect the committed changes.