Page MenuHomePhabricator

efl: docsProject
ActivePublic

Watchers

  • This project does not have any watchers.

Details

Description

project documentation

Recent Activity

Wed, Jan 22

q66 updated the task description for T8328: edocgen: Remaining issues.
Wed, Jan 22, 8:54 AM · efl: docs

Wed, Jan 15

segfaultxavi added a commit to T8557: Pending work on gesture event structs: rEFL090df4331b9c: evas_gesture: change getter methods to read-only properties.
Wed, Jan 15, 5:40 AM · efl: api, efl: docs, efl (efl-1.24)

Tue, Jan 14

bu5hm4n updated the task description for T8328: edocgen: Remaining issues.
Tue, Jan 14, 8:40 AM · efl: docs
bu5hm4n updated subscribers of T8328: edocgen: Remaining issues.

Just from the top of my head:

  • Right now there is this short version of "Inheritance" that starts with the parent class. I think it would be nice to have there as well the list of interfaces and mixins that are directly inherited, just with a link so you can click on it.
  • Maybe we can join the Inherited section with the event section, it feels akward to me to have them doubled.
  • The Members are kind of very "short" if this list gets shorter due to bullet point 2, we could make something that is a little bit more "verbose" telling what the members are etc.
  • The Titles in the property view could get links to jump back to the widget they are on.
  • The idea from k-s http://i.imgur.com/EINws0S.png to have something like "C usage" also looks very very nice, maybe something to consider ?
  • I get the navigation bar on every site, is it possibleto turn it off, its a little bit out of place here.
  • And a bug, taking https://www.enlightenment.org/develop/api/efl/ui/collection and clicking on Efl.Ui.Multi_Selectable.select_mode will not redirect you to a valid page.
Tue, Jan 14, 4:19 AM · efl: docs
Jaehyun_Cho added a revision to T8557: Pending work on gesture event structs: D11094: evas_gesture: change getter methods to read-only properties.
Tue, Jan 14, 4:08 AM · efl: api, efl: docs, efl (efl-1.24)

Mon, Jan 13

Jaehyun_Cho added a comment to T8557: Pending work on gesture event structs.

Thank you for your reply! Now I understand your point and I agree with you.

  • NOW : radius_get { } for Efl.Canvas.Gesture_Zoom
  • TODO : @property radius { get { } } for Efl.Canvas.Gesture_Zoom
Mon, Jan 13, 6:27 PM · efl: api, efl: docs, efl (efl-1.24)
segfaultxavi added a comment to T8557: Pending work on gesture event structs.

I'm not talking about Efl.Canvas.Gesture. This one is OK. I'm talking about the derived classes: Efl.Canvas.Gesture_Flick, Efl.Canvas.Gesture_Zoom, etc.
Some of these derived classes have methods called *_get, which look to me like they should be readonly properties.

Mon, Jan 13, 5:44 AM · efl: api, efl: docs, efl (efl-1.24)

Sun, Jan 12

Jaehyun_Cho added a comment to T8557: Pending work on gesture event structs.

Their fields should be read-only properties instead of methods. This is more natural for bindings.

Do you mean that EITHER Efl.Canvas.Gesture provides read-only properties OR Efl.Canvas.Gesture's setter methods / writable properties should not be public?

Sun, Jan 12, 10:24 PM · efl: api, efl: docs, efl (efl-1.24)

Thu, Jan 9

segfaultxavi triaged T8557: Pending work on gesture event structs as High priority.
Thu, Jan 9, 6:34 AM · efl: api, efl: docs, efl (efl-1.24)

Dec 26 2019

segfaultxavi added a comment to T8468: C# documentation for tuple properties is wrong.

I'm OK either way as long as everything is properly documented. Tuples+D10889 looked OK but I haven't looked at the current API using indexers yet.

Dec 26 2019, 2:41 AM · efl: language bindings, efl: docs

Dec 23 2019

felipealmeida added a comment to T8468: C# documentation for tuple properties is wrong.

Creating a new class for each tuple return does look more complicated than it needs to be IMO. However, with indexer, we are already creating new classes anyway, so maybe it could be worth it?

Dec 23 2019, 8:57 AM · efl: language bindings, efl: docs

Dec 22 2019

felipealmeida added a revision to T8359: C#: Add since information to second class API citizens: D10948: eolian: inherit since information from struct and enum to field.
Dec 22 2019, 5:34 AM · efl: language bindings, efl: docs

Dec 21 2019

felipealmeida claimed T8359: C#: Add since information to second class API citizens.
Dec 21 2019, 1:44 PM · efl: language bindings, efl: docs
felipealmeida claimed T8468: C# documentation for tuple properties is wrong.
Dec 21 2019, 1:42 PM · efl: language bindings, efl: docs

Dec 20 2019

segfaultxavi triaged T8540: mono-docs: setter and getter @since tags do not show in the docs as High priority.
Dec 20 2019, 2:35 AM · efl: language bindings, efl: docs

Dec 18 2019

segfaultxavi updated the task description for T7717: docs todo.
Dec 18 2019, 3:54 AM · efl (efl-1.24), efl: docs, efl: api

Dec 16 2019

jptiz added a revision to T8468: C# documentation for tuple properties is wrong: D10889: csharp: Generating documentation for tuple-value properties..
Dec 16 2019, 10:47 AM · efl: language bindings, efl: docs

Dec 13 2019

segfaultxavi added a comment to T8468: C# documentation for tuple properties is wrong.

That's what I was thinking of, yes. And I also agree it looks unnecessarily complicated.

Dec 13 2019, 4:16 AM · efl: language bindings, efl: docs

Dec 12 2019

jptiz added a comment to T8468: C# documentation for tuple properties is wrong.

Looks like we should not be using tuples as return values after all. It is recommended to use a explicit class, with proper fields and docs.

Dec 12 2019, 3:07 PM · efl: language bindings, efl: docs
segfaultxavi updated subscribers of T8468: C# documentation for tuple properties is wrong.

We should do something about this, docs are incomplete right now.

Dec 12 2019, 6:29 AM · efl: language bindings, efl: docs

Dec 3 2019

segfaultxavi added a parent task for T8227: Document units used in gesture classes: T8502: Efl.Canvas.Gesture.
Dec 3 2019, 9:12 AM · efl: docs

Dec 2 2019

segfaultxavi updated the task description for T6129: Write tutorials, guides and examples in C#.
Dec 2 2019, 8:39 AM · efl: language bindings, efl: docs

Nov 29 2019

segfaultxavi added a comment to T8496: edocgen: Remove links from stable to beta classes.

Correction: automatic documentation does reference sometimes beta classes, producing broken links.
For example, in the Full Hierarchy table.

Nov 29 2019, 4:20 AM · efl: docs
segfaultxavi triaged T8496: edocgen: Remove links from stable to beta classes as High priority.
Nov 29 2019, 4:05 AM · efl: docs
segfaultxavi closed T8495: edocgen: Beta class filtering is incomplete as Invalid.

OK, the files corresponding to BETA classes were old remnants which should have not been committed. Already removed them.
Please ignore this task.

Nov 29 2019, 3:53 AM · efl: docs
segfaultxavi triaged T8495: edocgen: Beta class filtering is incomplete as High priority.
Nov 29 2019, 3:39 AM · efl: docs

Nov 26 2019

lauromoura added a commit to T8359: C#: Add since information to second class API citizens: rEFL11094aeaaf00: csharp: Add more since tags to members.
Nov 26 2019, 8:00 AM · efl: language bindings, efl: docs

Nov 20 2019

segfaultxavi updated the task description for T7717: docs todo.
Nov 20 2019, 3:28 AM · efl (efl-1.24), efl: docs, efl: api

Nov 19 2019

segfaultxavi updated the task description for T7717: docs todo.
Nov 19 2019, 7:52 AM · efl (efl-1.24), efl: docs, efl: api
segfaultxavi updated the task description for T7717: docs todo.
Nov 19 2019, 7:46 AM · efl (efl-1.24), efl: docs, efl: api
segfaultxavi updated the task description for T7717: docs todo.
Nov 19 2019, 7:41 AM · efl (efl-1.24), efl: docs, efl: api

Nov 6 2019

segfaultxavi updated the task description for T7717: docs todo.
Nov 6 2019, 7:12 AM · efl (efl-1.24), efl: docs, efl: api
segfaultxavi updated the task description for T7717: docs todo.
Nov 6 2019, 6:52 AM · efl (efl-1.24), efl: docs, efl: api
segfaultxavi added a comment to T7717: docs todo.

It could be that these classes are currently unused, yes. @cedric should know. @cedric?

Nov 6 2019, 6:11 AM · efl (efl-1.24), efl: docs, efl: api

Nov 5 2019

akanad added a comment to T7717: docs todo.

@segfaultxavi
I tried to improve descriptions for efl_loop_message_future.eo and efl_loop_message_future_handler.eo.
They look like actually unused, though.
I mean they are created and assigned but there isn't a place that accesses or call some apis to those things.
Am I wrong?

Nov 5 2019, 11:50 PM · efl (efl-1.24), efl: docs, efl: api
segfaultxavi triaged T8468: C# documentation for tuple properties is wrong as High priority.
Nov 5 2019, 12:34 PM · efl: language bindings, efl: docs
segfaultxavi updated the task description for T7717: docs todo.
Nov 5 2019, 2:31 AM · efl (efl-1.24), efl: docs, efl: api

Oct 31 2019

zmike added a commit to T8359: C#: Add since information to second class API citizens: rEFLed7b20f4be34: csharp: Add since info to members related to events..
Oct 31 2019, 10:17 AM · efl: language bindings, efl: docs
segfaultxavi updated the task description for T7717: docs todo.
Oct 31 2019, 9:03 AM · efl (efl-1.24), efl: docs, efl: api

Oct 28 2019

segfaultxavi updated the task description for T7717: docs todo.
Oct 28 2019, 11:33 AM · efl (efl-1.24), efl: docs, efl: api

Oct 25 2019

segfaultxavi added a comment to T8171: document default values of properties.

This has been sitting here for a month and we need to do something about it, because the current state is not ideal:
The C# generator automatically adds docs to properties saying "The default value is X", taking that value from the the EO file.
But the truth is that implementations are free to use any default value they please, regardless of what the EO file says.
Default values currently in the EO files were chosen to match the implementations, but it is almost guaranteed that they will fall out of sync in the future.

Oct 25 2019, 6:50 AM · efl: docs

Oct 17 2019

zmike edited projects for T7329: Document the release process on the Enlightenment site, added: efl (efl-1.24); removed efl (efl-1.23).
Oct 17 2019, 7:04 AM · efl (efl-1.24), efl: docs, efl: release team
zmike edited projects for T7761: eina: eina_future_as_value needs improved docs, added: efl (efl-1.24); removed efl (efl-1.23).
Oct 17 2019, 7:04 AM · efl (efl-1.24), efl: docs
zmike edited projects for T7704: verify @since tags for stabilized apis, added: efl (efl-1.24); removed efl (efl-1.23).
Oct 17 2019, 7:03 AM · efl (efl-1.24), efl: docs, efl: api
zmike edited projects for T7182: split legacy examples into examples repo as submodule, added: efl (efl-1.24); removed efl (efl-1.23).
Oct 17 2019, 7:02 AM · efl (efl-1.24), Active Work Proposal, major change, Restricted Project, efl: docs
zmike edited projects for T6127: Provide documentation for C#, added: efl (efl-1.24); removed efl (efl-1.23).
Oct 17 2019, 7:02 AM · efl (efl-1.24), Active Work Proposal, major change, efl: docs
zmike edited projects for T7717: docs todo, added: efl (efl-1.24); removed efl (efl-1.23).
Oct 17 2019, 7:02 AM · efl (efl-1.24), efl: docs, efl: api

Oct 16 2019

lauromoura moved T8359: C#: Add since information to second class API citizens from Backlog to InProgress on the efl: language bindings board.
Oct 16 2019, 11:57 AM · efl: language bindings, efl: docs

Oct 15 2019

lauromoura added a revision to T8359: C#: Add since information to second class API citizens: D10419: csharp: Add more since tags to members.
Oct 15 2019, 2:50 PM · efl: language bindings, efl: docs

Oct 12 2019

felipealmeida added a revision to T8359: C#: Add since information to second class API citizens: D10385: csharp: Add since documentation to struct and struct fields.
Oct 12 2019, 3:53 PM · efl: language bindings, efl: docs