eina_cxx: add documentation to the Eina C++ header files.
authorvitor.sousa <vitorsousasilva@gmail.com>
Wed, 4 Jun 2014 20:34:42 +0000 (22:34 +0200)
committerCedric BAIL <c.bail@partner.samsung.com>
Wed, 4 Jun 2014 20:34:47 +0000 (22:34 +0200)
commit0902b6a6f8ce10aefc9c19d455fd5c176e2bd53a
tree33d4493ae8d0519886bbb7c487a88fafbef8ce59
parent5e7a9b1225f792a6a7e60e96cf402440ad1adfff
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>
20 files changed:
doc/Doxyfile.in
src/bindings/eina_cxx/Eina.hh
src/bindings/eina_cxx/eina_accessor.hh
src/bindings/eina_cxx/eina_clone_allocators.hh
src/bindings/eina_cxx/eina_error.hh
src/bindings/eina_cxx/eina_inarray.hh
src/bindings/eina_cxx/eina_inlist.hh
src/bindings/eina_cxx/eina_integer_sequence.hh
src/bindings/eina_cxx/eina_iterator.hh
src/bindings/eina_cxx/eina_lists_auxiliary.hh
src/bindings/eina_cxx/eina_log.hh
src/bindings/eina_cxx/eina_optional.hh
src/bindings/eina_cxx/eina_ptrarray.hh
src/bindings/eina_cxx/eina_ptrlist.hh
src/bindings/eina_cxx/eina_range_types.hh
src/bindings/eina_cxx/eina_ref.hh
src/bindings/eina_cxx/eina_stringshare.hh
src/bindings/eina_cxx/eina_thread.hh
src/bindings/eina_cxx/eina_type_traits.hh
src/bindings/eina_cxx/eina_value.hh