* doc/Doxyfile.in: Improve member functions presentation. * doc/DoxygenLayout.xml: Fix invalid xml elements. --- scribo/ChangeLog | 8 ++++++++ scribo/doc/Doxyfile.in | 18 ++++++++++-------- scribo/doc/DoxygenLayout.xml | 2 +- 3 files changed, 19 insertions(+), 9 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index ede4371..a987ade 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,13 @@ 2013-03-20 Guillaume Lazzara <z@lrde.epita.fr> + Improve documentation layout. + + * doc/Doxyfile.in: Improve member functions presentation. + + * doc/DoxygenLayout.xml: Fix invalid xml elements. + +2013-03-20 Guillaume Lazzara <z@lrde.epita.fr> + Improve documentation of Scribo. * doc/scribo/binarization/binarization.dox, diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index b215839..bc0f2c7 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -1,5 +1,5 @@ -# Copyright (C) 2011, 2012 EPITA Research and Development Laboratory -# (LRDE) +# Copyright (C) 2011, 2012, 2013 EPITA Research and Development +# Laboratory (LRDE) # # This file is part of Olena. # @@ -32,9 +32,9 @@ REPEAT_BRIEF = YES ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = YES -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES STRIP_FROM_PATH = @top_srcdir@/scribo -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = @top_srcdir@/scribo SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = NO @@ -46,7 +46,7 @@ OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO BUILTIN_STL_SUPPORT = YES IDL_PROPERTY_SUPPORT = NO -DISTRIBUTE_GROUP_DOC = NO +DISTRIBUTE_GROUP_DOC = YES SUBGROUPING = YES INLINE_GROUPED_CLASSES = NO SORT_GROUP_NAMES = YES @@ -71,6 +71,7 @@ INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = YES SORT_BY_SCOPE_NAME = YES +SORT_MEMBERS_CTORS_1ST = YES GENERATE_TODOLIST = NO GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES @@ -105,9 +106,10 @@ EXCLUDE = @top_srcdir@/scribo/demo \ @top_srcdir@/scribo/sandbox \ @top_srcdir@/scribo/doc/user-refman \ @top_srcdir@/scribo/doc/devel-refman \ - @top_srcdir@/scribo/tests/unit_test + @top_srcdir@/scribo/tests/unit_test \ + @top_srcdir@/scribo/+* EXCLUDE_SYMLINKS = YES -EXCLUDE_PATTERNS = *spe.hh +EXCLUDE_PATTERNS = *.spe.hh *.moc.cc EXCLUDE_SYMBOLS = *_ mln::trait::* EXAMPLE_PATH = @top_srcdir@/scribo/doc/examples \ @top_srcdir@/scribo/doc/outputs \ @@ -143,7 +145,7 @@ VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = mln:: +IGNORE_PREFIX = scribo:: #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- diff --git a/scribo/doc/DoxygenLayout.xml b/scribo/doc/DoxygenLayout.xml index e9d1901..b3bf627 100644 --- a/scribo/doc/DoxygenLayout.xml +++ b/scribo/doc/DoxygenLayout.xml @@ -1,4 +1,5 @@ <doxygenlayout version="1.0"> + <!-- Generated by doxygen 1.8.3.1-20130209 --> <!-- Navigation index tabs for HTML output --> <navindex> <tab type="mainpage" visible="yes" title="Scribo"/> @@ -18,7 +19,6 @@ <tab type="filelist" visible="yes" title="" intro=""/> <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="dirs" visible="yes" title="" intro=""/> <tab type="examples" visible="yes" title="" intro=""/> </navindex> -- 1.7.2.5