[Olena-patches] 3069: Make the doc part of the distribution.

* doc/Doxyfile.in: make the user doc lighter. * doc/Makefile.am: add the doc as extra dist. * mln/core/internal/graph_window_base.hh * mln/core/site_set/box.hh * mln/core/site_set/p_complex.hh * tests/morpho/complex_image_wst.cc, * tests/morpho/tree/data.cc, * trash/display_color_pretty.cc, * doc/benchmark/canvas.cc, * doc/examples/erosion.cc: fix doxygen warnings. * doc/tutorial/samples/Makefile.am: do not install sample programs. * mln/fun/l2l/relabel.hh: fix wrong guards. --- milena/ChangeLog | 21 +++++++++++++++++++ milena/doc/Doxyfile.in | 27 +++++++++++++----------- milena/doc/Makefile.am | 7 +++-- milena/doc/benchmark/canvas.cc | 2 +- milena/doc/examples/erosion.cc | 2 +- milena/doc/tutorial/samples/Makefile.am | 6 ++-- milena/mln/core/internal/graph_window_base.hh | 2 +- milena/mln/core/site_set/box.hh | 2 +- milena/mln/core/site_set/p_complex.hh | 14 +++++++----- milena/mln/fun/l2l/relabel.hh | 8 +++--- milena/tests/morpho/complex_image_wst.cc | 2 +- milena/tests/morpho/tree/data.cc | 4 +- milena/trash/display_color_pretty.cc | 7 ++--- 13 files changed, 65 insertions(+), 39 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 35b9b75..dcf963a 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,24 @@ +2008-12-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + + Make the doc part of the distribution. + + * doc/Doxyfile.in: make the user doc lighter. + + * doc/Makefile.am: add the doc as extra dist. + + * mln/core/internal/graph_window_base.hh + * mln/core/site_set/box.hh + * mln/core/site_set/p_complex.hh + * tests/morpho/complex_image_wst.cc, + * tests/morpho/tree/data.cc, + * trash/display_color_pretty.cc, + * doc/benchmark/canvas.cc, + * doc/examples/erosion.cc: fix doxygen warnings. + + * doc/tutorial/samples/Makefile.am: do not install sample programs. + + * mln/fun/l2l/relabel.hh: fix wrong guards. + 2008-12-18 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; Make the tutorial part of the distribution. diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 64fd5b8..6209339 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -28,6 +28,7 @@ ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO BUILTIN_STL_SUPPORT = YES +IDL_PROPERTY_SUPPORT = NO DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES #--------------------------------------------------------------------------- @@ -48,16 +49,18 @@ HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO -SORT_BY_SCOPE_NAME = NO +SORT_BRIEF_DOCS = YES +SORT_BY_SCOPE_NAME = YES GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_DIRECTORIES = YES +SHOW_USED_FILES = NO # Disabled for light doc +SHOW_DIRECTORIES = NO # Disabled for light doc +SHOW_FILES = NO # Disabled for light doc +SHOW_NAMESPACES = YES FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages @@ -84,7 +87,7 @@ EXCLUDE = @top_srcdir@/milena/sandbox \ @top_srcdir@/milena/doc/tutorial/samples EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *spe.hh -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = EXAMPLE_PATH = @top_srcdir@/milena/doc/tutorial/samples \ @top_builddir@/milena/doc/tutorial/samples \ @top_builddir@/milena/doc/tutorial/outputs \ @@ -105,7 +108,7 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES -REFERENCES_LINK_SOURCE = YES +REFERENCES_LINK_SOURCE = NO USE_HTAGS = NO VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- @@ -300,23 +303,23 @@ CLASS_DIAGRAMS = YES HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES +COLLABORATION_GRAPH = NO # Disabled for light doc +GROUP_GRAPHS = NO # Disabled for light doc UML_LOOK = NO TEMPLATE_RELATIONS = YES -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES +INCLUDE_GRAPH = NO # Disabled for light doc +INCLUDED_BY_GRAPH = NO # Disabled for light doc CALL_GRAPH = NO CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES +DIRECTORY_GRAPH = NO # Disabled for light doc DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = MAX_DOT_GRAPH_DEPTH = 1000 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES +GENERATE_LEGEND = NO # Disabled for light doc DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 39b52fd..aa1b30c 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -51,12 +51,13 @@ edit_user = sed -e 's,OUTPUT_DIRECTORY = ./complete/,OUTPUT_DIRECTORY -e 's,INTERNAL_DOCS = YES,INTERNAL_DOCS = NO,g' \ -e 's,GENERATE_TODOLIST = YES,GENERATE_TODOLIST = NO,g' \ -e 's,PROJECT_NUMBER = \",PROJECT_NUMBER = \"User documentation ,g' \ - -e 's,EXCLUDE_SYMBOLS =,EXCLUDE_SYMBOLS = *::internal*,g' + -e 's,EXCLUDE_SYMBOLS =,EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::*,g' -EXTRA_DIST = \ -Doxyfile.in +EXTRA_DIST = \ +Doxyfile.in \ +$(top_builddir)/milena/doc/user CLEANFILES = \ Doxyfile_complete \ diff --git a/milena/doc/benchmark/canvas.cc b/milena/doc/benchmark/canvas.cc index 5b6b294..b40a6c3 100644 --- a/milena/doc/benchmark/canvas.cc +++ b/milena/doc/benchmark/canvas.cc @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file doc/bench/canvas.cc +/// \file doc/benchmark/canvas.cc /// /// Test on mln::labeling::level. diff --git a/milena/doc/examples/erosion.cc b/milena/doc/examples/erosion.cc index b11d574..8d0d51c 100644 --- a/milena/doc/examples/erosion.cc +++ b/milena/doc/examples/erosion.cc @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file doc/examples/my_test.cc +/// \file doc/examples/erosion.cc /// /// Test on mln::morpho::hit_or_miss. diff --git a/milena/doc/tutorial/samples/Makefile.am b/milena/doc/tutorial/samples/Makefile.am index 6e61992..c15db7c 100644 --- a/milena/doc/tutorial/samples/Makefile.am +++ b/milena/doc/tutorial/samples/Makefile.am @@ -2,7 +2,7 @@ include $(top_srcdir)/milena/doc/doc.mk -bin_PROGRAMS = \ +noinst_PROGRAMS = \ accu-right-instanciation \ borderthickness \ box2d-bbox \ @@ -44,7 +44,7 @@ bin_PROGRAMS = \ win-create-1 \ win-create-2 -bin_PROGRAMS += \ +noinst_PROGRAMS += \ tuto1_first_image accu_right_instanciation_SOURCES = accu-right-instanciation.cc @@ -96,7 +96,7 @@ all: clean-figures run-samples: all @failcom='exit 1'; \ - list='$(bin_PROGRAMS)'; for bin in $$list; do \ + list='$(noinst_PROGRAMS)'; for bin in $$list; do \ echo "Running $$bin"; \ ./$$bin > $(OUTPUTS_BUILDDIR)/$$bin.txt || eval $$failcom; \ done diff --git a/milena/mln/core/internal/graph_window_base.hh b/milena/mln/core/internal/graph_window_base.hh index d2ecfd5..a72472c 100644 --- a/milena/mln/core/internal/graph_window_base.hh +++ b/milena/mln/core/internal/graph_window_base.hh @@ -30,7 +30,7 @@ # include <mln/core/concept/window.hh> -/// \file mln/internal/graph_window_base.hh +/// \file mln/core/internal/graph_window_base.hh /// /// FIXME: doc diff --git a/milena/mln/core/site_set/box.hh b/milena/mln/core/site_set/box.hh index 93973fe..469655c 100644 --- a/milena/mln/core/site_set/box.hh +++ b/milena/mln/core/site_set/box.hh @@ -176,7 +176,7 @@ namespace mln // Procedures - /// Return the minimum box including box \p a and box \b + /// Return the minimum box including box \p a and box \p b template <typename P> inline box<P> diff --git a/milena/mln/core/site_set/p_complex.hh b/milena/mln/core/site_set/p_complex.hh index 3fcb7da..f071f6a 100644 --- a/milena/mln/core/site_set/p_complex.hh +++ b/milena/mln/core/site_set/p_complex.hh @@ -29,7 +29,8 @@ # define MLN_CORE_SITE_SET_P_COMPLEX_HH /// \file mln/core/site_set/p_complex.hh -/// \brief Definition of a point set based on a complex. +/// +/// Definition of a point set based on a complex. # include <mln/core/internal/site_set_base.hh> @@ -103,7 +104,7 @@ namespace mln /* FIXME: Aggregate site data (location). */ - /** \brief A complex psite set based on the N-faces of a complex + /** A complex psite set based on the N-faces of a complex of dimension \tparam D (a \p D-complex). \arg \p D The dimension of the complex. @@ -118,9 +119,10 @@ namespace mln typedef internal::site_set_base_< complex_psite<D, G>, self_ > super_; public: - /// \brief Construct a complex psite set from a complex. + /// Construct a complex psite set from a complex. /// /// \param cplx The complex upon which the complex psite set is built. + /// \param geom FIXME p_complex(const topo::complex<D>& cplx, const G& geom); /// Associated types. @@ -141,7 +143,7 @@ namespace mln typedef fwd_piter piter; /// \} - /// \brief Return The number of sites of the set, i.e., the number + /// Return The number of sites of the set, i.e., the number /// of \em faces. /// /// (Required by the mln::Site_Set concept, since the property @@ -201,7 +203,7 @@ namespace mln }; - /// \brief Comparison between two mln::p_complex's. + /// Comparison between two mln::p_complex's. /// /// Two mln::p_complex's are considered equal if they share the /// same complex. @@ -209,7 +211,7 @@ namespace mln bool operator==(const p_complex<D, G>& lhs, const p_complex<D, G>& rhs); - /// \brief Inclusion of a mln::p_complex in another one. + /// Inclusion of a mln::p_complex in another one. /// /// This inclusion relation is very strict for the moment, since our /// infrastrure for complexs is simple: a mln::p_complex is included diff --git a/milena/mln/fun/l2l/relabel.hh b/milena/mln/fun/l2l/relabel.hh index 8435e1e..6e8eb9b 100644 --- a/milena/mln/fun/l2l/relabel.hh +++ b/milena/mln/fun/l2l/relabel.hh @@ -25,10 +25,10 @@ // reasons why the executable file might be covered by the GNU General // Public License. -#ifndef MLN_FUN_L2L_ARRAY_HH -# define MLN_FUN_L2L_ARRAY_HH +#ifndef MLN_FUN_L2L_RELABEL_HH +# define MLN_FUN_L2L_RELABEL_HH -/// \file mln/fun/l2l/array.hh +/// \file mln/fun/l2l/relabel.hh /// /// Function mapping a label to a new one. /// \sa mln::labeling::relabel @@ -204,4 +204,4 @@ namespace mln } // end of namespace mln -#endif // ! MLN_FUN_L2L_ARRAY_HH +#endif // ! MLN_FUN_L2L_RELABEL_HH diff --git a/milena/tests/morpho/complex_image_wst.cc b/milena/tests/morpho/complex_image_wst.cc index a1e7cf6..3d53982 100644 --- a/milena/tests/morpho/complex_image_wst.cc +++ b/milena/tests/morpho/complex_image_wst.cc @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/morpho/complex_image_swt.cc +/// \file tests/morpho/complex_image_wst.cc /// /// Testing Meyer's Watershed Transform on mln::complex_image. diff --git a/milena/tests/morpho/tree/data.cc b/milena/tests/morpho/tree/data.cc index 6fccab0..e341423 100644 --- a/milena/tests/morpho/tree/data.cc +++ b/milena/tests/morpho/tree/data.cc @@ -25,9 +25,9 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/morpho/tree/parent.cc +/// \file tests/morpho/tree/data.cc /// -/// Tests on mln::morpho::tree::parent. +/// Tests on mln::morpho::tree::data. #include <mln/core/image/image2d.hh> #include <mln/core/alias/neighb2d.hh> diff --git a/milena/trash/display_color_pretty.cc b/milena/trash/display_color_pretty.cc index b9de1ca..d41ee2a 100644 --- a/milena/trash/display_color_pretty.cc +++ b/milena/trash/display_color_pretty.cc @@ -25,10 +25,9 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/display/color_pretty.cc - * - * \brief Tests on mln::display::color::pretty. - */ +/// \file tests/display/color_pretty.cc +/// +/// Tests on mln::display::color::pretty. # include <mln/core/image/image2d.hh> # include <mln/value/int_u8.hh> -- 1.5.6.5