* doc/Doxyfile.in: Do not show namespaces in names. * doc/DoxygenLayout.xml: Improve menu. --- milena/ChangeLog | 8 +++++++ milena/doc/Doxyfile.in | 4 +- milena/doc/DoxygenLayout.xml | 48 ++++++++++++++++++++++++----------------- 3 files changed, 38 insertions(+), 22 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 756259b..c59a08e 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + More improvements in documentation layout. + + * doc/Doxyfile.in: Do not show namespaces in names. + + * doc/DoxygenLayout.xml: Improve menu. + +2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Tag internal documentation. * apps/graph-morpho/morpho.hh, diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 9b1cfd6..6ebdcf4 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -564,7 +564,7 @@ SHOW_FILES = NO # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. -SHOW_NAMESPACES = YES +SHOW_NAMESPACES = NO # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from @@ -859,7 +859,7 @@ ALPHABETICAL_INDEX = YES # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) -COLS_IN_ALPHA_INDEX = 5 +COLS_IN_ALPHA_INDEX = 2 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. diff --git a/milena/doc/DoxygenLayout.xml b/milena/doc/DoxygenLayout.xml index 5559bca..05f050a 100644 --- a/milena/doc/DoxygenLayout.xml +++ b/milena/doc/DoxygenLayout.xml @@ -2,23 +2,31 @@ <!-- Navigation index tabs for HTML output --> <navindex> <tab type="mainpage" visible="yes" title="Milena"/> - <tab type="pages" visible="yes" title="" intro=""/> - <tab type="modules" visible="yes" title="" intro=""/> - <tab type="namespaces" visible="yes" title=""> - <tab type="namespacelist" visible="yes" title="" intro=""/> - <tab type="namespacemembers" visible="yes" title="" intro=""/> + <tab type="pages" visible="no" title="" intro=""/> + <tab type="usergroup" url="@ref mainpage" title="Getting started"> + <tab type="user" url="@ref quickref" title="Quick Reference Guide"/> + <tab type="user" url="@ref tutorial" title="Tutorial"/> </tab> - <tab type="classes" visible="yes" title=""> - <tab type="classlist" visible="yes" title="" intro=""/> + <tab type="modules" visible="yes" title="API Reference Manual" intro=""/> + <tab type="namespaces" visible="no" title=""> + <tab type="namespacelist" visible="no" title="" intro=""/> + <tab type="namespacemembers" visible="no" title="" intro=""/> + </tab> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title="All Classes"/> + <tab type="classes" visible="no" title=""> + <tab type="classlist" visible="no" title="" intro=""/> <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> - <tab type="hierarchy" visible="yes" title="" intro=""/> - <tab type="classmembers" visible="yes" title="" intro=""/> + <tab type="hierarchy" visible="no" title="" intro=""/> + <tab type="classmembers" visible="no" title="" intro=""/> </tab> - <tab type="files" visible="yes" title=""> + <tab type="files" visible="no" title=""> <tab type="filelist" visible="yes" title="" intro=""/> <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="examples" visible="yes" title="" intro=""/> + <tab type="examples" visible="yes" title="Examples" intro=""/> + <tab type="user" url="@ref examples" title="Examples"/> + <tab type="user" url="@ref demos" title="Demos"/> + <tab type="user" url="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Publications" title="Publications"/> </navindex> <!-- Layout definition for a class page --> @@ -29,20 +37,20 @@ <collaborationgraph visible="$COLLABORATION_GRAPH"/> <allmemberslink visible="yes"/> <memberdecl> - <nestedclasses visible="yes" title=""/> - <publictypes title=""/> - <publicslots title=""/> - <signals title=""/> <publicmethods title=""/> <publicstaticmethods title=""/> <publicattributes title=""/> <publicstaticattributes title=""/> - <protectedtypes title=""/> - <protectedslots title=""/> <protectedmethods title=""/> <protectedstaticmethods title=""/> <protectedattributes title=""/> <protectedstaticattributes title=""/> + <publictypes title=""/> + <publicslots title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <nestedclasses visible="yes" title=""/> + <signals title=""/> <packagetypes title=""/> <packagemethods title=""/> <packagestaticmethods title=""/> @@ -62,15 +70,15 @@ </memberdecl> <detaileddescription title=""/> <memberdef> - <inlineclasses title=""/> - <typedefs title=""/> - <enums title=""/> <constructors title=""/> <functions title=""/> <related title=""/> <variables title=""/> <properties title=""/> <events title=""/> + <inlineclasses title=""/> + <typedefs title=""/> + <enums title=""/> </memberdef> <usedfiles visible="$SHOW_USED_FILES"/> <authorsection visible="yes"/> -- 1.7.2.5