Summary:
this has always been broken, it was just never noticed because colorselector
was broken
@fix
ref T8304
Reviewers: segfaultxavi
Reviewed By: segfaultxavi
Subscribers: segfaultxavi, cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8304
Differential Revision: https://phab.enlightenment.org/D10278
Summary:
PACKAGE_DATA_DIR was set to the build dir instead to the elementary
specific data dir.
ref T8304
Reviewers: segfaultxavi
Reviewed By: segfaultxavi
Subscribers: segfaultxavi, cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8304
Differential Revision: https://phab.enlightenment.org/D10275
Summary:
While the target name implies a compression we only ever put this all
into a tar archive so far. Using xz compression as we do with our source
archives.
Also adjust the file naming to avoid clashing with the source tarballs.
We used -doc with autotools before, so this is really more of a catchup.
Reviewers: bu5hm4n, segfaultxavi
Reviewed By: segfaultxavi
Subscribers: ProhtMeyhet, cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D10266
item class is not initialized to 0. This can crash gengrid later on.
Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org>
Differential Revision: https://phab.enlightenment.org/D10261
Without this, the prefix would get pointed to something like
/path/to/efl/build/share/evas, which is not a valid path when
building. That would cause the docs build to fail.
Version 2.45 of DocFX seems much much faster than previous 2.40, but could just
be a matter of stale caches. Anyway, no breakages have been detected.
Using an online symbol resolution server (https://xref.docs.microsoft.com)
adds some more links for .NET symbols (and no noticeable slowdown).
Otherwise, <remarks> section DIV at the namespace level is always
shown, even if empty. And we do not want that now that the DIV has
a background color.
Summary:
The mono generator adds a <remarks> section to all BETA classes with an explanatory text.
These tags are understood by DocFX and Monodevelop.
On top of this, this commit modifies the DocFX template to give the Remarks section a more
prominent place in the page.
Test Plan: Render docs, Beta classes should have a big blue box with a remark about the class being Beta and dangerous.
Reviewers: lauromoura, vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D9381
comment it out and move it closer to the block that needs it to make
it obvious ... we don't need it.
i'm all-in-all not that into the eps conversion thing for docs there
too... :(
Get your seatbelt fastend! It is happening! AUTOTOOLS IS GONE NOW!
All praise to meson!
This time the final version, ci has been adjusted, and now does not try
anymore to build a removed buildsystem. However, the scripts in there
need cleaning up.
Differential Revision: https://phab.enlightenment.org/D9027
The setup script copied ALL media files, but only the C# tutorials and guides.
A lot of space can be saved in the generated _site folder if only the media
files relevant to C# are copied.
Summary:
this here brings one new top level target which is doc. It is not build
by default, and does rerun everything on every call.
ninja doc will create previews and run the doxygen command. After this
is done, a tarbal of the html & man will be created, latex is not added
for now, due to the unability to compile the resulting .tex files.
Nothing of the documentation is installed for now, if this would be
enabled, then every single ninja install would regenerate the whole
documentation again, which is quite a lot, and quite a pain (and
sometimes crashes)
While porting this over, i encountered a problem with *convert* the bug
report is linked in the comment.
fix T7781
Depends on D8690
Reviewers: zmike, segfaultxavi, cedric
Reviewed By: segfaultxavi
Subscribers: #reviewers, #committers
Tags: #efl
Maniphest Tasks: T7781
Differential Revision: https://phab.enlightenment.org/D8561
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.
Mike Blumenkrantz
Marcel Hollerbach
Stefan Schmidt
Ross Vandegrift
Daniel Kolesa
Xavi Artigas
Carsten Haitzler
junsu choi
Cedric BAIL
Bowon Ryu
Andy Williams
Thiep Ha