Summary:
This was making "ninja doc" segfault for me.
If these function tables are not initialized they contain garbage, which leads
to the worst kind of undefined behavior.
Test Plan: Apply D8561 and try `ninja doc`. It was dumping core for me, and it does not do it anymore after this patch.
Reviewers: bu5hm4n, zmike, cedric
Reviewed By: bu5hm4n
Subscribers: #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8697
Reference page titles are now "Class Efl.Ui.Win" instead of "Class Win".
And also remove Namespace and Assembly sections.
Namespace is redundant since we use fully-qualified names everywhere.
Assembly is useless since we build the docs from the source so this entry is
always "temp.dll".
In the EFL API we have several objects with the same name in different namespaces.
Thus it is important to use fully-qualified names throughout the docs, to avoid
confusion.
However, the default DocFX templates prefer using only simple class names.
The default templates have already been modified to use full names everywhere
except in the list of derived classes in the hierarchy section, where a DocFX
bug was hit.
This commit is a workaround to that bug (see
https://github.com/dotnet/docfx/issues/3769#issuecomment-485616064 )
so full names (with links) are used in the whole hierarchy.
These classes need to be public so new user-created classes can inherit
from them, but they have the same content as the regular classes.
Therefore there is no need to pollute the documentation with duplicated
elements.
Summary:
These templates add the following features:
- Collapsible sections for simpler reading
- Full class names in ancestors list
(Could not make it work for descendants)
- Removed duplicated Implements section
- Removed huge Inherited Members section
- Extended maximum number of hierarchy levels from 5 to 10
(because our hierarchy is really that big)
Test Plan:
Follow the doc/docfx README to generate the HTML pages and enjoy the improved
and slightly-more-usable docs.
Reviewers: lauromoura, bu5hm4n, zmike, cedric
Reviewed By: lauromoura
Subscribers: #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D7832
Summary: Usage instructions in the README file.
Test Plan:
Follow the README to produce the documentation pages.
Point your browser to docfx/_site/index.html to see the results.
Reviewers: lauromoura, bu5hm4n, cedric, myoungwoon, zmike
Reviewed By: lauromoura, bu5hm4n
Subscribers: #reviewers, #committers
Tags: #efl
Maniphest Tasks: T7424
Differential Revision: https://phab.enlightenment.org/D7502
The elementary examples were built before, but not now.
I guess it was missed when we merged elementary to efl source tree.
This enables it and fixes some references.
there was a 'line-height: 0%;' that resulted in unreadable edc code in
the Edje Data Collection reference documentation page.
Thank you Jeremy Suntheimer for spotting that!
fix T5438
Summary:
Since eina_model was dropped some years ago.
Also a few other points where related stuff is just commented out.
Reviewers: iscaro, barbieri
Reviewed By: barbieri
Subscribers: cedric, jpeg
Differential Revision: https://phab.enlightenment.org/D4442
Summary:
fix warnings while generating documents
- end of file while inside a group (eina_util.h)
- missing title after \defgroup
- ignoring title "Ecore_Con_Lib_Group" that does not match old title
Reviewers: Hermet
Subscribers: cedric, jpeg
Differential Revision: https://phab.enlightenment.org/D4420
While elm docs have been merged in they never have been accessible from the
main page of our docs. Fix this by including elm_intro.h and referencing it
from the main page. While we are at it rename it to the scheme we used in EFL.
Another missing piece was the index with all widget references. Never brought
over form the elm legacy tree. Putting this in and we are now at least able to
navigate to all elm widget pages.
I didn't know preview generation was so slow and done completely serialy.
There is potential improvement here. Still need to kind of merge the
documentation into something readable.
Doxygen uses its on preprocessor and this one missed the
EFL_BETA_API_SUPPORT=1 define so none our our BETA api hidden behind
it was build for our documentation.
ref T2541