Page MenuHomePhabricator

efl: docsProject
ActivePublic

Watchers

  • This project does not have any watchers.

Details

Description

project documentation

Recent Activity

Apr 1 2020

netstar closed T6515: Move Edi skeleton projects to Meson, a subtask of T5330: Evaluate and review how easy it is to write new EFL based application, as Resolved.
Apr 1 2020, 7:19 AM · efl: api, efl: docs

Mar 23 2020

felipealmeida moved T6128: Generate C# reference API documentation from InProgress to Done on the efl: language bindings board.
Mar 23 2020, 10:20 AM · efl: language bindings, efl: docs

Feb 13 2020

felipealmeida closed T8468: C# documentation for tuple properties is wrong as Resolved.
Feb 13 2020, 10:39 AM · efl: language bindings, efl: docs
felipealmeida added a commit to T8468: C# documentation for tuple properties is wrong: rEFL651517808cfd: csharp: Generating documentation for tuple-value properties..
Feb 13 2020, 10:39 AM · efl: language bindings, efl: docs
q66 updated the task description for T8328: edocgen: Remaining issues.
Feb 13 2020, 5:55 AM · efl: docs

Feb 10 2020

felipealmeida moved T8359: C#: Add since information to second class API citizens from InProgress to Done on the efl: language bindings board.
Feb 10 2020, 1:14 PM · efl: language bindings, efl: docs

Feb 6 2020

q66 updated the task description for T8328: edocgen: Remaining issues.
Feb 6 2020, 6:02 AM · efl: docs
segfaultxavi updated the task description for T6129: Write tutorials, guides and examples in C#.
Feb 6 2020, 2:16 AM · efl: language bindings, efl: docs

Feb 5 2020

lucas closed T8600: Add missing @since to tests docs that are stable as Resolved by committing rEFL269ed1ca346b: bindings-cxx: fix missing @since tags at stable c#/cpp tests.
Feb 5 2020, 8:17 AM · Restricted Project, efl: docs
lucas added a revision to T8600: Add missing @since to tests docs that are stable: D11265: bindings-cxx: fix missing @since tags.
Feb 5 2020, 6:02 AM · Restricted Project, efl: docs

Feb 4 2020

lucas triaged T8600: Add missing @since to tests docs that are stable as Trivial priority.
Feb 4 2020, 6:46 AM · Restricted Project, efl: docs

Jan 31 2020

segfaultxavi added a comment to T8328: edocgen: Remaining issues.

That is true, if a method doesn't have its own docs (like most constructor), it's not worth putting them at the forefront of the documentation.
This will remove a lot of unnecessary text from the current docs.
For example, Efl.Ui.Button (here) will have an empty Public methods section.

Jan 31 2020, 1:52 AM · efl: docs

Jan 30 2020

bu5hm4n added a comment to T8328: edocgen: Remaining issues.

Are you sure you are not meaning with the second kind the overrides and implements that have a special documentation ?

Jan 30 2020, 11:30 AM · efl: docs
segfaultxavi added a comment to T8328: edocgen: Remaining issues.

Regarding how to render inheritance, let's recap:

Jan 30 2020, 10:14 AM · efl: docs
q66 updated the task description for T8328: edocgen: Remaining issues.
Jan 30 2020, 7:55 AM · efl: docs

Jan 27 2020

segfaultxavi closed T8588: Ampersand is not escaped in some <value> tags. as Resolved by committing rEFL5d982dd985c6: csharp: Escape contents of struct fields' value tag..
Jan 27 2020, 8:56 AM · Restricted Project, efl: language bindings, efl: docs
jptiz added a revision to T8588: Ampersand is not escaped in some <value> tags.: D11202: csharp: Escape contents of struct fields' value tag..
Jan 27 2020, 8:37 AM · Restricted Project, efl: language bindings, efl: docs
segfaultxavi triaged T8588: Ampersand is not escaped in some <value> tags. as Normal priority.
Jan 27 2020, 7:55 AM · Restricted Project, efl: language bindings, efl: docs
jptiz reopened T8588: Ampersand is not escaped in some <value> tags. as "Open".
Jan 27 2020, 7:54 AM · Restricted Project, efl: language bindings, efl: docs

Jan 22 2020

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

Jan 15 2020

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

Jan 14 2020

bu5hm4n updated the task description for T8328: edocgen: Remaining issues.
Jan 14 2020, 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.
Jan 14 2020, 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.
Jan 14 2020, 4:08 AM · efl: api, efl: docs, efl (efl-1.24)

Jan 13 2020

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
Jan 13 2020, 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.

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

Jan 12 2020

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?

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

Jan 9 2020

segfaultxavi triaged T8557: Pending work on gesture event structs as High priority.
Jan 9 2020, 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