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
The error message was:
/usr/bin/ld: preview_text_filter.o: undefined reference to symbol 'efl_gfx_filter_program_set'
//home/batden/Enlightenment20/efl/src/lib/efl/.libs/libefl.so.1: error adding symbols: DSO missing from command line
Until we're happy with it, keep the API as beta.
The EDC support should not change, and the Lua either, but the
API could potentially still change to accomodate for new needs
(vector graphics, anyone?). If we're happy with the current
interface, then we can remove the @beta flags.
Deep down internally there was already a name, but no API could
really set it properly.
Here Edje will set the name of the filter based on the part name
or the data item name if relevant.
This creates the new interface
Efl.Gfx.Filter
And the implementation is a mixin (evas_filter_mixin.c):
Evas.Filter
All the filter rendering code has now been moved to this
new file. TODO: Merge image filtering.
Using eina::string_view in eolian generated interfaces (instead of
std::string) to allow lightweight passing of both C strings and C++
std::string.
Also, No longer using eina::optional in generated headers for types
that already implements the concept of null state (like Eo wrappers
and eina_accessor).
Also fix allocating callback objects require by class methods
(i.e. static) in static vectors so the memory will be freed when the
programs exit.
Added a new test case for testing callbacks on class methods.
Moved method definitions and supplementary code from generated C++
wrappers to auxiliary header file (.eo.impl.hh) generated together
with the main ".eo.hh" file. Updated Makefiles to list such files in
the compilation and cleanup processes. Updated .gitignore to include
these new generated files.
Made general adjustments on the documentation of generated C++ wrappers
Added "PREDEFINED" preprocessor macro definition in the Doxyfile.in in
order to make some adjustments for better documentation in the C++
generated headers. Excluding generation of documentation for classes
in the "eo_cxx" namespace (the namespace for "abstract" eolian C++
wrappers). Now generating the documentation for the events too.
Hiding some auxiliary code from being documented. Some aesthetic
adjustments for generated white space. Generate documentation for the
main constructor of C++ wrappers and added auxiliary grammars to list
parameters names.
While we used different variation of mkdir -p all over we also had spots
where we did not use the option. This is one step in trying to make our
build system ready for parallel install. Using something like -j 10 even
for the install should help to speed up our jenkins jobs as well as distcheck.
Summary:
While going through eina for understanding, wrote a program to understand
he differences between different eina inarray functions. Thought, this might
be useful for others too, so adding the same.
Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com>
Reviewers: devilhorns
Subscribers: cedric
Differential Revision: https://phab.enlightenment.org/D1803
Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Summary:
Add top padding to prevent overlapping between "Value:" and below
strings when long macro is used.
Reviewers: raster, cedric
Subscribers: cedric
Differential Revision: https://phab.enlightenment.org/D1582
Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Now @since have a left colored border, like @deprecaded, @note, etc
Also keep the number on the same line:
instead of:
since
1.10
it now render as:
since 1.10
Summary: The Eo tutorial had a tough readability. It is better now: stars are not messing around with the code, plus code does not collide anymore with a bullet in a bullet list.
Reviewers: cedric, JackDanielZ, tasn
Reviewed By: tasn
Subscribers: cedric
Differential Revision: https://phab.enlightenment.org/D1230
This allows people to disable the building of anything GUI related.
In my case, it is used for servers.
I encourage anyone that think they can do a better patch to improve it,
as i dislike having to add all those AM_CONDITIONAL().
Maybe the macros should be improved.
Summary:
Added documentation to almost all classes that are intended for direct use by the library users.
Marked classes/functions used by the library itself as @internal.
Modified the Doxyfile.in to enable the generation of documentation to the bindings.
Reviewers: felipealmeida, cedric, woohyun, smohanty, raster
CC: savio, cedric
Differential Revision: https://phab.enlightenment.org/D947
Signed-off-by: Cedric BAIL <c.bail@partner.samsung.com>
Summary:
The setting SYMBOL_CACHE_SIZE has been deprecated and will
generate a warning when Doxygen runs. This change comments out that
configuration setting to prevent the warning.
Test Plan: make doc 2> doxyerr.log
CC: cedric
Differential Revision: https://phab.enlightenment.org/D599
Signed-off-by: Cedric BAIL <cedric.bail@samsung.com>
Set the proper transparent & alpha flags on the Ecore_Evas,
add a tranparent rectangle and boom, the images are all nice and
transparent. This will fix the bg color in the page evasfiltersref.
Nightly build failed with (make doc):
cd: ../../../src/lib/eo/.libs: No such file or directory
Looks like there's one too many ../
I guess the build dir is not the source dir on the build bots.
The filter code is a copy and paste from the doc.
Maybe the code should be in an include file, so we're sure the
preview and the documentation code are the same?
Yes, I know. Someone hates large fonts.
But the ones currently used are so SMALL!
Also, this will just revert back to what's defined in e.css,
because body and list font size aren't even consistent.
Also, display the page titles like titles: big fat blue letters.
If a param description is long and spans on multiple lines,
then the param name should be aligned to the first description
line. Otherwise the layout becomes confusing.
Align [in] and [out] vertically like params.
sort changes output based on locale. even between C and en_US etc.
letalone all the other interesting ones. this causes the sorted order
to keep changing of the images. this forces locale to C to make it
always the same order.
Xavi Artigas
Cedric BAIL
Bowon Ryu
Andy Williams
Thiep Ha
Hermet Park
Jeeyong Um
Marcel Hollerbach
Bruno Dilly
Jee-Yong Um
Stefan Schmidt
Felipe Magno de Almeida
Amitesh Singh
Jean-Philippe Andre
Cedric BAIL
Yomi
Stefan Schmidt
Vitor Sousa
Bryce Harrington
Srivardhan Hebbar
Tae-Hwan Kim
Mike Blumenkrantz
Savio Sena
Davide Andreoli
Jean Guyomarc'h
Guillaume Friloux
Mike Blumenkrantz
Jeff Grimshaw
Carsten Haitzler
Cedric BAIL
Daniel Juyung Seo
Jihoon Kim
Sebastian Dransfeld