[Olena-patches] olena-2.0-72-gcf3ec15 Add new documentation groups.

* doc/Doxyfile.in: Use .dox file. * doc/Makefile.am: New dependencies. * mln/core/concept/object.hh: Move doc content... * doc/mainpage.dox: ... here. * doc/groups/accu.hh, * doc/groups/graph.hh, * doc/groups/images.hh, * doc/groups/main.hh, * doc/groups/neighb.hh, * doc/groups/site_set.hh, * doc/groups/util.hh, * doc/groups/win.hh: Rename ... * doc/groups/accu.dox, * doc/groups/graph.dox, * doc/groups/images.dox, * doc/groups/main.dox, * doc/groups/neighb.dox, * doc/groups/site_set.dox, * doc/groups/util.dox, * doc/groups/win.dox: ... as this. --- milena/ChangeLog | 29 ++++++ milena/doc/Doxyfile.in | 5 +- milena/doc/Makefile.am | 19 ++-- milena/doc/groups/{accu.hh => accu.dox} | 0 milena/doc/groups/{graph.hh => graph.dox} | 0 milena/doc/groups/{images.hh => images.dox} | 0 milena/doc/groups/{main.hh => main.dox} | 0 milena/doc/groups/{neighb.hh => neighb.dox} | 0 milena/doc/groups/{site_set.hh => site_set.dox} | 0 milena/doc/groups/{util.hh => util.dox} | 0 milena/doc/groups/{win.hh => win.dox} | 0 milena/doc/mainpage.dox | 121 +++++++++++++++++++++++ milena/mln/core/concept/object.hh | 73 -------------- 13 files changed, 163 insertions(+), 84 deletions(-) rename milena/doc/groups/{accu.hh => accu.dox} (100%) rename milena/doc/groups/{graph.hh => graph.dox} (100%) rename milena/doc/groups/{images.hh => images.dox} (100%) rename milena/doc/groups/{main.hh => main.dox} (100%) rename milena/doc/groups/{neighb.hh => neighb.dox} (100%) rename milena/doc/groups/{site_set.hh => site_set.dox} (100%) rename milena/doc/groups/{util.hh => util.dox} (100%) rename milena/doc/groups/{win.hh => win.dox} (100%) create mode 100644 milena/doc/mainpage.dox diff --git a/milena/ChangeLog b/milena/ChangeLog index 6a780fc..6aec8b7 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,32 @@ +2012-02-27 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + + Add new documentation groups. + + * doc/Doxyfile.in: Use .dox file. + + * doc/Makefile.am: New dependencies. + + * mln/core/concept/object.hh: Move doc content... + * doc/mainpage.dox: ... here. + + * doc/groups/accu.hh, + * doc/groups/graph.hh, + * doc/groups/images.hh, + * doc/groups/main.hh, + * doc/groups/neighb.hh, + * doc/groups/site_set.hh, + * doc/groups/util.hh, + * doc/groups/win.hh: Rename ... + + * doc/groups/accu.dox, + * doc/groups/graph.dox, + * doc/groups/images.dox, + * doc/groups/main.dox, + * doc/groups/neighb.dox, + * doc/groups/site_set.dox, + * doc/groups/util.dox, + * doc/groups/win.dox: ... as this. + 2012-02-01 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; * mln/registration/icp.hh: Cite article. diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 7790ce6..5cbaaef 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -84,7 +84,7 @@ FILE_VERSION_FILTER = #--------------------------------------------------------------------------- QUIET = YES WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" @@ -96,7 +96,8 @@ INPUT = @top_srcdir@/milena FILE_PATTERNS = *.cc \ *.hh \ *.hxx \ - *.hcc + *.hcc \ + *.dox RECURSIVE = YES EXCLUDE = @top_srcdir@/milena/sandbox \ @top_srcdir@/milena/trash \ diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 99dd4c6..3437f58 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -693,14 +693,14 @@ regen-am: EXTRA_DIST += \ $(DATA_html_dirs) \ $(DOXYFILE).in \ - groups/accu.hh \ - groups/graph.hh \ - groups/images.hh \ - groups/main.hh \ - groups/neighb.hh \ - groups/site_set.hh \ - groups/util.hh \ - groups/win.hh \ + groups/accu.dox \ + groups/graph.dox \ + groups/images.dox \ + groups/main.dox \ + groups/neighb.dox \ + groups/site_set.dox \ + groups/util.dox \ + groups/win.dox \ img/small-enlarged.png \ img/small.png \ doxyfuns.sty \ @@ -708,7 +708,8 @@ EXTRA_DIST += \ tools/clearbanner.sh \ tools/sample_utils.hh \ tools/split_sample.sh \ - tools/todoxygen.sh + tools/todoxygen.sh \ + mainpage.dox ## ---------- ## diff --git a/milena/doc/groups/accu.hh b/milena/doc/groups/accu.dox similarity index 100% rename from milena/doc/groups/accu.hh rename to milena/doc/groups/accu.dox diff --git a/milena/doc/groups/graph.hh b/milena/doc/groups/graph.dox similarity index 100% rename from milena/doc/groups/graph.hh rename to milena/doc/groups/graph.dox diff --git a/milena/doc/groups/images.hh b/milena/doc/groups/images.dox similarity index 100% rename from milena/doc/groups/images.hh rename to milena/doc/groups/images.dox diff --git a/milena/doc/groups/main.hh b/milena/doc/groups/main.dox similarity index 100% rename from milena/doc/groups/main.hh rename to milena/doc/groups/main.dox diff --git a/milena/doc/groups/neighb.hh b/milena/doc/groups/neighb.dox similarity index 100% rename from milena/doc/groups/neighb.hh rename to milena/doc/groups/neighb.dox diff --git a/milena/doc/groups/site_set.hh b/milena/doc/groups/site_set.dox similarity index 100% rename from milena/doc/groups/site_set.hh rename to milena/doc/groups/site_set.dox diff --git a/milena/doc/groups/util.hh b/milena/doc/groups/util.dox similarity index 100% rename from milena/doc/groups/util.hh rename to milena/doc/groups/util.dox diff --git a/milena/doc/groups/win.hh b/milena/doc/groups/win.dox similarity index 100% rename from milena/doc/groups/win.hh rename to milena/doc/groups/win.dox diff --git a/milena/doc/mainpage.dox b/milena/doc/mainpage.dox new file mode 100644 index 0000000..df9eac0 --- /dev/null +++ b/milena/doc/mainpage.dox @@ -0,0 +1,121 @@ +/** \mainpage Documentation of milena + + \section intro_sec Introduction + +Milena is a generic C++ library, providing many data structures for +image processing as well as algorithms, in particular in the field of +mathematical morphology. It is used as the base image processing +library in all Olena modules. + +\subsection mlnimagestruct Images and Structures + +Milena can be used on: + +\li images based on regular grids (1D, 2D, 3D, ...), +\li images based on (undirected) graphs, +\li images based on complexes (http://en.wikipedia.org/wiki/Simplicial_complex), +\li any subset of the previous image types, +\li any of the previous images modified by a geometrical/topological transformation. + +Core concepts of morphology and topology like adjacency and (resp.) +structuring elements are represented by neighborhood and window +(resp.) objects. Milena provides classical neighborhoods and windows +(e.g., for 4- and 8-connexity on regular 2D grids, adjacent vertices +on graphs, etc.), but users can define their own objects, and use them +seamlessly with existing or new algorithms. + +\subsection mlnvalues Values + +Milena supports many different value types and may therefore be used +with virtually any real-world image inputs and outputs, as well as new +and original image types. + +Currently handled values types are: + +\li Boolean (binary) values, +\li n-bit integers (with fixed n), +\li n-bit floating-point values (with fixed n), +\li n-bit gray-level values (with fixed n), +\li RGB, HSI, HSL color values, +\li labels (with no arithmetic), +\li fixed-size tuples and vectors of the previous value types. + +These value types can be freely used with any image type and any +algorithm, provided the combination is valid. Users can provide +missing definitions when they want to handle non-covered cases. For +instance, they can write a definition of the supremum on the set of +RGB values to compute the morphological dilation of an RGB color +image. + + + \section quickstart Quick Start + + If you are new at using Milena, take a look at the following pages : + + \li \ref quickref + \li \ref tutorial + + \section mln_sec Overview of Milena. + + <UL> + <LI> \ref mln + <LI> \ref mln::accu + <LI> \ref mln::algebra + <LI> \ref mln::arith + <LI> \ref mln::binarization + <LI> \ref mln::border + <LI> \ref mln::canvas + <LI> \ref mln::convert + <LI> \ref mln::data + <LI> \ref mln::debug + <LI> \ref mln::display + <LI> \ref mln::draw + <LI> \ref mln::estim + <LI> \ref mln::extension + <LI> \ref mln::fun + <LI> \ref mln::geom + <LI> \ref mln::graph + <LI> \ref mln::histo + <LI> \ref mln::io + <LI> \ref mln::labeling + <LI> \ref mln::data + <LI> \ref mln::linear + <LI> \ref mln::literal + <LI> \ref mln::logical + <LI> \ref mln::make + <LI> \ref mln::math + <LI> \ref mln::metal + <LI> \ref mln::morpho + <LI> \ref mln::norm + <LI> \ref mln::opt + <LI> \ref mln::pw + <LI> \ref mln::registration + <LI> \ref mln::set + <LI> \ref mln::tag + <LI> \ref mln::test + <LI> \ref mln::topo + <LI> \ref mln::trace + <LI> \ref mln::trait + <LI> \ref mln::transform + <LI> \ref mln::util + <LI> \ref mln::value + <LI> \ref mln::win + + \section copyright Copyright and License. + Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and + Development (LRDE) + + This documentation is part of Olena. + + Olena is free software: you can redistribute it and/or modify it under + the terms of the GNU General Public License as published by the Free + Software Foundation, version 2 of the License. + + Olena is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with Olena. If not, see <http://www.gnu.org/licenses/>. + */ diff --git a/milena/mln/core/concept/object.hh b/milena/mln/core/concept/object.hh index 4d58fbf..6fefeba 100644 --- a/milena/mln/core/concept/object.hh +++ b/milena/mln/core/concept/object.hh @@ -54,79 +54,6 @@ # include <mln/metal/math/all.hh> -/** \mainpage Documentation of milena - - \section intro_sec Introduction - - This is the documentation of Milena. - - \section mln_sec Overview of Milena. - - <UL> - <LI> \ref mln - <LI> \ref mln::accu - <LI> \ref mln::algebra - <LI> \ref mln::arith - <LI> \ref mln::binarization - <LI> \ref mln::border - <LI> \ref mln::canvas - <LI> \ref mln::convert - <LI> \ref mln::data - <LI> \ref mln::debug - <LI> \ref mln::display - <LI> \ref mln::draw - <LI> \ref mln::estim - <LI> \ref mln::extension - <LI> \ref mln::fun - <LI> \ref mln::geom - <LI> \ref mln::graph - <LI> \ref mln::histo - <LI> \ref mln::io - <LI> \ref mln::labeling - <LI> \ref mln::data - <LI> \ref mln::linear - <LI> \ref mln::literal - <LI> \ref mln::logical - <LI> \ref mln::make - <LI> \ref mln::math - <LI> \ref mln::metal - <LI> \ref mln::morpho - <LI> \ref mln::norm - <LI> \ref mln::opt - <LI> \ref mln::pw - <LI> \ref mln::registration - <LI> \ref mln::set - <LI> \ref mln::tag - <LI> \ref mln::test - <LI> \ref mln::topo - <LI> \ref mln::trace - <LI> \ref mln::trait - <LI> \ref mln::transform - <LI> \ref mln::util - <LI> \ref mln::value - <LI> \ref mln::win - - \section copyright Copyright and License. - Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and - Development (LRDE) - - This documentation is part of Olena. - - Olena is free software: you can redistribute it and/or modify it under - the terms of the GNU General Public License as published by the Free - Software Foundation, version 2 of the License. - - Olena is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with Olena. If not, see <http://www.gnu.org/licenses/>. - */ - - - /** \namespace mln \brief The namespace mln corresponds to the Milena (mini-Olena) project. -- 1.7.2.5