olena-2.0-471-gaf99848 Add references to code examples

* doc/DoxygenLayout.xml: Change example section name. * doc/examples.dox: Add more links to example files. --- milena/ChangeLog | 8 ++++++++ milena/doc/DoxygenLayout.xml | 2 +- milena/doc/examples.dox | 11 +++++++++-- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 890523f..d3014e9 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-11 Guillaume Lazzara <z@lrde.epita.fr> + Add references to code examples + + * doc/DoxygenLayout.xml: Change example section name. + + * doc/examples.dox: Add more links to example files. + +2013-04-11 Guillaume Lazzara <z@lrde.epita.fr> + Hide internal API and classes in documentation. * doc/Doxyfile.in: Exclude internal symbols and classes. diff --git a/milena/doc/DoxygenLayout.xml b/milena/doc/DoxygenLayout.xml index ae704ea..cc73c43 100644 --- a/milena/doc/DoxygenLayout.xml +++ b/milena/doc/DoxygenLayout.xml @@ -20,7 +20,7 @@ <tab type="filelist" visible="yes" title="" intro=""/> <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="examples" visible="yes" title="Examples" intro=""/> + <tab type="examples" visible="yes" title="Full Examples" intro=""/> <tab type="user" url="@ref examples" title="Examples"/> <tab type="user" url="http://caroussel.lrde.epita.fr/olena/demos" title="Demos"/> <tab type="user" url="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Publications" title="Publications"/> diff --git a/milena/doc/examples.dox b/milena/doc/examples.dox index ef6845e..ab18c38 100644 --- a/milena/doc/examples.dox +++ b/milena/doc/examples.dox @@ -1,7 +1,14 @@ /*! \page examples Examples -\section examplerag Region Adjacency Graph +\section examplesgenericity Genericity -\li \link region_adjacency_graph.cc +\li \link demos/genericity/neighborhood/neighborhood.cc Classical neighborhoods \endlink +\li \link demos/genericity/neighborhood/duality.cc Dual neighborhoods \endlink +\li \link demos/genericity/neighborhood/permissive.cc Custom neighborhoods \endlink +\li \link demos/inter_pixel/inter_pixel.cc Inter-pixel processings \endlink + + +\section examplesgraph Graphs +\li \link demos/graph/region_adjacency_graph.cc Region Adjacency Graph \endlink */ -- 1.7.2.5
participants (1)
-
Guillaume Lazzara