Commit Graph

23 Commits

Author SHA1 Message Date
Stefan Schmidt ce93ef0378 docs: Build documentation also for code that is still in BETA.
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
2015-08-11 14:04:51 +02:00
Vitor Sousa d530389898 eolian_cxx: Add protected methods and events to C++ wrappers and fixes
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.
2015-04-14 01:06:57 -03:00
Davide Andreoli 34c75a29f6 Edcref: and finally apply a cool style
Now the edc ref is decently readable
2014-08-08 02:30:33 +02:00
vitor.sousa 0902b6a6f8 eina_cxx: add documentation to the Eina C++ header files.
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>
2014-06-04 22:34:47 +02:00
Jeff Grimshaw a1791e5701 doc: remove deprecated setting SYMBOL_CACHE_SIZE
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>
2014-03-05 14:16:29 +09:00
Carsten Haitzler f6ee3fc8b5 documentation style cleanup for release
this cleans up the doxygen generated docs to be acceptable for a
release - style is changed and unused images removed etc.
2014-02-21 22:26:26 +09:00
Lucas De Marchi 4e3804041f Rename edbus->eldbus
git grep -l edbus2 | while read f; do sed -i 's/edbus2/eldbus/g' "$f"; done
find . -name '*edbus2*' -exec rename edbus2 eldbus {} \;

git grep -l "EDBUS" | while read f; do sed -i 's/EDBUS/ELDBUS/g' "$f"; done
git grep -l "EDBus" | while read f; do sed -i 's/EDBus/Eldbus/g' "$f"; done
git grep -l "edbus (v2)" | while read f; do sed -i 's/edbus (v2)/eldbus/g' "$f"; done
git grep -l "Edbus" | while read f; do sed -i 's/Edbus/Eldbus/g' "$f"; done
git grep -l "edbus" | while read f; do sed -i 's/edbus/eldbus/g' "$f"; done

find . -name '*edbus*' -exec rename edbus eldbus {} \;
find . -name '*EDBus*' -exec rename EDBus Eldbus {} \;
2013-04-23 12:36:29 -03:00
Gustavo Sverzut Barbieri 60d31170fb doc exclude some evas internal stuff.
SVN revision: 82691
2013-01-12 08:32:37 +00:00
Gustavo Sverzut Barbieri dfb84c1657 efl: merge emotion.
this one was quite a huge work, but hopefully it's correct.

NOTES:
 * removed vlc generic module, it should go into a separate package.
 * gstreamer is enabled by default (see --disable-gstreamer)
 * xine is disabled by default (see --enable-gstreamer)
 * generic is always built statically if supported
 * gstreamer and xine can't be configured as static (just lacks command line options, build system supports it)
 * v4l2 is enabled by default on linux if eeze is built (see --disable-v4l2)
 * emotion_test moved to src/tests/emotion and depends on EFL_ENABLE_TESTS (--with-tests), but is still installed if enabled.

TODO (need your help!):
 * fix warnings with gstreamer and xine engine
 * call engine shutdown functions if building as static
 * remove direct usage of PACKAGE_*_DIR and use eina_prefix
 * add eina_prefix checkme file as evas and others
 * add support for $EFL_RUN_IN_TREE
 * create separate package for emotion_generic_modules
 * check docs hierarchy (doxygen is segv'in here)



SVN revision: 82501
2013-01-10 03:43:32 +00:00
Gustavo Sverzut Barbieri c96a620b46 efl/edje: improve docs after merge.
SVN revision: 82142
2013-01-04 02:51:43 +00:00
Gustavo Sverzut Barbieri 9ea2ce1041 efl: merge edje.
this is still in progress, mostly the multisense stuff is pending.

it seems that when we merge ecore_audio in edje the libremix and
similar are gone, at least from Edje, and will be in ecore_audio
itself (or pulseaudio).

Changes:
 * __UNUSED__ to EINA_UNUSED
 * binaries (epp, embryo_cc, edje_cc) now consider EFL_RUN_IN_TREE and
   will assume the binaries are still not installed, running from
   build tree location (needs more testing, maybe doesn't work with
   srcdir != builddir, still doesn't solve cross compile builds)



SVN revision: 82139
2013-01-04 02:08:14 +00:00
Gustavo Sverzut Barbieri 9e0788cc2e efl: merge ephysics
changes:
 * __UNUSED__ -> EINA_UNUSED
 * Fixed doc hierarchy



SVN revision: 82126
2013-01-03 22:10:40 +00:00
Gustavo Sverzut Barbieri 68188ac0c8 efl: merge eeze.
Changes also in this commit:
 * fix missing EAPI in symbols used by modules
 * removed old libudev and libmount support as agreed by discomfitor/zmike
 * replaced __UNUSED__ with EINA_UNUSED
 * fixed docs hierarchy



SVN revision: 82100
2013-01-03 20:37:42 +00:00
Gustavo Sverzut Barbieri 4bc0210bd3 efl: merge efreet.
seems to be fine, pass distcheck and friends. please report.

changes:
 - documentation hierarchy fixes
 - replaced __UNUSED__ with EINA_UNUSED
 - replaced PKG_DATA_DIR with PACKAGE_DATA_DIR"/efreet"



SVN revision: 81889
2012-12-29 23:04:40 +00:00
Gustavo Sverzut Barbieri 2608f68571 efl/docs: clean-up and make it more uniform.
now unified docs are bit more uniform in their start pages, overall
improved but much to do :-(



SVN revision: 81851
2012-12-28 23:26:05 +00:00
Gustavo Sverzut Barbieri 489bbff765 efl/eio: fix docs.
SVN revision: 81846
2012-12-28 20:47:25 +00:00
Gustavo Sverzut Barbieri 331488d1ce efl: merge edbus (v2).
SVN revision: 81825
2012-12-28 17:53:25 +00:00
Daniel Zaoui eed9825834 Eo tutorial in Doxygen format.
Signed-off-by: Daniel Zaoui <daniel.zaoui@samsung.com>

SVN revision: 81681
2012-12-24 12:55:14 +00:00
Jonas M. Gastal 0809af70fb efl: Adding *.dox files from various libs.
SVN revision: 81274
2012-12-18 16:13:03 +00:00
Jonas M. Gastal 6ecaa33f22 efl: Adding a unified main page that links to the "mainpage" of libs.
SVN revision: 81273
2012-12-18 16:12:56 +00:00
Vincent Torri a9c0f6ce8e merge: update Doxyfile
SVN revision: 78513
2012-10-26 09:06:30 +00:00
Stefan Schmidt cedf5d0cf9 Doxyfile.in: Remove obsolte doxygen tags from all our Doxyfile.in files.
Doygen tells us:
warning: Tag `SHOW_DIRECTORIES' at line 507 of file Doxyfile has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag `HTML_ALIGN_MEMBERS' at line 879 of file Doxyfile has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag `USE_INLINE_TREES' at line 1065 of file Doxyfile has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

So we are nice and remove them. A yay for the day where we have amerged tree and
not two dozens of Doxyfile.in files floating around.

SVN revision: 78409
2012-10-24 19:50:29 +00:00
Vincent Torri 371defbd32 merge: add COPYING files (BSD 2-clause, LGPL and GPL) and doc
doc though head.html should be improved :)



SVN revision: 76843
2012-09-19 06:57:03 +00:00