[Olena-patches] milena r1472: Fix doxygen expressions

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena ChangeLog: 2007-11-13 Simon Nivault &lt;simon.nivault(a)lrde.epita.fr&gt; Fix doxygen expressions. * mln/core/a_point_of.hh, * mln/core/mesh_psite.hh, * mln/core/p_priority_queue.hh, * mln/fun/p2b/all.hh, * mln/trait/op/all.hh, * mln/trait/op/preinc.hh, * mln/trait/value/print.hh, * mln/util/branch_iter.hh, * mln/util/branch_iter_ind.hh, * mln/value/gray.hh, * mln/value/graylevel.hh, * mln/value/int_s.hh, * mln/value/int_u.hh, * mln/value/rgb.hh, * sandbox/duhamel/color_sub.cc, * sandbox/duhamel/labeling_algo.cc, * sandbox/duhamel/labeling_level.hh, * sandbox/duhamel/labeling_level_fast.cc, * sandbox/duhamel/labeling_level_fast_10000x1000.cc, * sandbox/duhamel/labeling_level_generic_10000x1000.cc, * sandbox/garrigues/fllt2.hh, * tests/convert_to_p_vec.cc, * tests/core_p_priority_queue.cc, * tests/core_p_priority_queue_fast.cc, * tests/core_p_queue.cc, * tests/core_p_queue_fast.cc, * tests/core_p_set.cc, * tests/core_pset_if.cc, * tests/norm/l1.cc, * tests/norm/l2.cc, * tests/norm/linfty.cc, * tests/pset_if.cc: Remove. * tests/tree_fast_to_image.cc: Fix. --- mln/core/a_point_of.hh | 2 - mln/core/mesh_psite.hh | 2 - mln/core/p_priority_queue.hh | 6 +-- mln/fun/p2b/all.hh | 2 - mln/trait/op/all.hh | 2 - mln/trait/op/preinc.hh | 2 - mln/trait/value/print.hh | 2 - mln/util/branch_iter.hh | 7 ++- mln/util/branch_iter_ind.hh | 35 +++++++++---------- mln/value/gray.hh | 15 +++++++- mln/value/graylevel.hh | 6 ++- mln/value/int_s.hh | 14 ++++++- mln/value/int_u.hh | 14 ++++++- mln/value/rgb.hh | 4 +- sandbox/duhamel/color_sub.cc | 4 +- sandbox/duhamel/labeling_algo.cc | 2 - sandbox/duhamel/labeling_level.hh | 2 - sandbox/duhamel/labeling_level_fast.cc | 2 - sandbox/duhamel/labeling_level_fast_10000x1000.cc | 2 - sandbox/duhamel/labeling_level_generic_10000x1000.cc | 2 - sandbox/garrigues/fllt2.hh | 12 +++--- tests/convert_to_p_vec.cc | 2 - tests/core_p_priority_queue.cc | 2 - tests/core_p_priority_queue_fast.cc | 2 - tests/core_p_queue.cc | 2 - tests/core_p_queue_fast.cc | 2 - tests/core_p_set.cc | 2 - tests/core_pset_if.cc | 2 - tests/norm/l1.cc | 6 ++- tests/norm/l2.cc | 6 ++- tests/norm/linfty.cc | 6 ++- tests/tree_fast_to_image.cc | 4 +- 32 files changed, 108 insertions(+), 67 deletions(-) Index: trunk/milena/tests/pset_if.cc (deleted) =================================================================== Index: trunk/milena/tests/core_p_queue.cc =================================================================== --- trunk/milena/tests/core_p_queue.cc (revision 1471) +++ trunk/milena/tests/core_p_queue.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/p_queue.cc +/*! \file tests/core_p_queue.cc * * \brief Tests on mln::p_queue. */ Index: trunk/milena/tests/core_p_priority_queue.cc =================================================================== --- trunk/milena/tests/core_p_priority_queue.cc (revision 1471) +++ trunk/milena/tests/core_p_priority_queue.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/p_priority_queue.cc +/*! \file tests/core_p_priority_queue.cc * * \brief Tests on mln::p_priority_queue. */ Index: trunk/milena/tests/core_p_set.cc =================================================================== --- trunk/milena/tests/core_p_set.cc (revision 1471) +++ trunk/milena/tests/core_p_set.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/p_set.cc +/*! \file tests/core_p_set.cc * * \brief Tests on mln::p_set. */ Index: trunk/milena/tests/convert_to_p_vec.cc =================================================================== --- trunk/milena/tests/convert_to_p_vec.cc (revision 1471) +++ trunk/milena/tests/convert_to_p_vec.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/convert_to_vec_p.cc +/*! \file tests/convert_to_p_vec.cc * * \brief Tests on mln::convert::to_vec_p. */ Index: trunk/milena/tests/core_pset_if.cc =================================================================== --- trunk/milena/tests/core_pset_if.cc (revision 1471) +++ trunk/milena/tests/core_pset_if.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/pset_if.cc +/*! \file tests/core_pset_if.cc * * \brief Tests on mln::pset_if. */ Index: trunk/milena/tests/core_p_priority_queue_fast.cc =================================================================== --- trunk/milena/tests/core_p_priority_queue_fast.cc (revision 1471) +++ trunk/milena/tests/core_p_priority_queue_fast.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/p_priority_queue_fast.cc +/*! \file tests/core_p_priority_queue_fast.cc * * \brief Tests on mln::p_priority_queue_fast. */ Index: trunk/milena/tests/tree_fast_to_image.cc =================================================================== --- trunk/milena/tests/tree_fast_to_image.cc (revision 1471) +++ trunk/milena/tests/tree_fast_to_image.cc (revision 1472) @@ -26,9 +26,9 @@ // Public License. /*! - * \file tests/tree_to_image.cc + * \file tests/tree_fast_to_image.cc * - * \brief test of mln::util::tree_to_image + * \brief test of mln::util::tree_fast_to_image * */ Index: trunk/milena/tests/norm/l1.cc =================================================================== --- trunk/milena/tests/norm/l1.cc (revision 1471) +++ trunk/milena/tests/norm/l1.cc (revision 1472) @@ -25,8 +25,10 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/l1.hh -/// \brief Test the L1-norm. +/*! \file tests/norm/l1.hh + * + * \brief Test the L1-norm. + */ #include <cassert> Index: trunk/milena/tests/norm/l2.cc =================================================================== --- trunk/milena/tests/norm/l2.cc (revision 1471) +++ trunk/milena/tests/norm/l2.cc (revision 1472) @@ -25,8 +25,10 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/l2.hh -/// \brief Test the L2-norm. +/*! \file tests/norm/l2.hh + * + * \brief Test the L2-norm. + */ #include <cmath> #include <cassert> Index: trunk/milena/tests/norm/linfty.cc =================================================================== --- trunk/milena/tests/norm/linfty.cc (revision 1471) +++ trunk/milena/tests/norm/linfty.cc (revision 1472) @@ -25,8 +25,10 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/linfty.hh -/// \brief Test the L-infinity-norm. +/*! \file tests/norm/linfty.hh + * + * \brief Test the L-infinity-norm. + */ #include <cmath> #include <cassert> Index: trunk/milena/tests/core_p_queue_fast.cc =================================================================== --- trunk/milena/tests/core_p_queue_fast.cc (revision 1471) +++ trunk/milena/tests/core_p_queue_fast.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/p_queue_fast.cc +/*! \file tests/core_p_queue_fast.cc * * \brief Tests on mln::p_queue_fast. */ Index: trunk/milena/mln/trait/value/print.hh =================================================================== --- trunk/milena/mln/trait/value/print.hh (revision 1471) +++ trunk/milena/mln/trait/value/print.hh (revision 1472) @@ -28,7 +28,7 @@ #ifndef MLN_TRAIT_VALUE_PRINT_HH # define MLN_TRAIT_VALUE_PRINT_HH -/*! \file mln/trait/values/print.hh +/*! \file mln/trait/value/print.hh * * \brief Print the collection of traits for an value type. */ Index: trunk/milena/mln/trait/op/all.hh =================================================================== --- trunk/milena/mln/trait/op/all.hh (revision 1471) +++ trunk/milena/mln/trait/op/all.hh (revision 1472) @@ -29,7 +29,7 @@ # define MLN_TRAIT_OP_ALL_HH /*! - * \file all.hh + * \file mln/trait/op/all.hh * * \brief FIXME * Index: trunk/milena/mln/trait/op/preinc.hh =================================================================== --- trunk/milena/mln/trait/op/preinc.hh (revision 1471) +++ trunk/milena/mln/trait/op/preinc.hh (revision 1472) @@ -28,7 +28,7 @@ #ifndef MLN_TRAIT_OP_PREINC_HH # define MLN_TRAIT_OP_PREINC_HH -/*! \file mln/trait/op/predec.hh +/*! \file mln/trait/op/preinc.hh * * \brief Declaration of the "unary pre-decrementation" operator trait. */ Index: trunk/milena/mln/core/mesh_psite.hh =================================================================== --- trunk/milena/mln/core/mesh_psite.hh (revision 1471) +++ trunk/milena/mln/core/mesh_psite.hh (revision 1472) @@ -28,7 +28,7 @@ #ifndef MLN_MESH_PSITE_HH # define MLN_MESH_PSITE_HH -/*! \file mln/core/mesh_p.hh +/*! \file mln/core/mesh_psite.hh * * \brief Definition of a graph-based point site. * Index: trunk/milena/mln/core/p_priority_queue.hh =================================================================== --- trunk/milena/mln/core/p_priority_queue.hh (revision 1471) +++ trunk/milena/mln/core/p_priority_queue.hh (revision 1472) @@ -25,8 +25,8 @@ // reasons why the executable file might be covered by the GNU General // Public License. -#ifndef MLN_CORE_QUEUE_P_PRIORITY_HH -# define MLN_CORE_QUEUE_P_PRIORITY_HH +#ifndef MLN_CORE_P_PRIORITY_QUEUE_HH +# define MLN_CORE_P_PRIORITY_QUEUE_HH /*! \file mln/core/p_priority_queue.hh * @@ -334,4 +334,4 @@ } // end of namespace mln -#endif // ! MLN_CORE_QUEUE_P_PRIORITY_HH +#endif // ! MLN_CORE_P_PRIORITY_QUEUE_HH Index: trunk/milena/mln/core/a_point_of.hh =================================================================== --- trunk/milena/mln/core/a_point_of.hh (revision 1471) +++ trunk/milena/mln/core/a_point_of.hh (revision 1472) @@ -28,7 +28,7 @@ #ifndef MLN_CORE_A_POINT_OF_HH # define MLN_CORE_A_POINT_OF_HH -/*! \file mln/core/a_point_oft.hh +/*! \file mln/core/a_point_of.hh * * \brief Give a point of an image. */ Index: trunk/milena/mln/value/graylevel.hh =================================================================== --- trunk/milena/mln/value/graylevel.hh (revision 1471) +++ trunk/milena/mln/value/graylevel.hh (revision 1472) @@ -50,20 +50,22 @@ namespace mln { - /// \{ Fwd decls. namespace literal { + /// \{ Fwd decls. struct black_t; struct medium_gray_t; struct white_t; + /// \} } namespace value { + /// \{ Fwd decls. class gray; template <unsigned n> struct graylevel; struct float01_f; - } /// \} + } Index: trunk/milena/mln/value/gray.hh =================================================================== --- trunk/milena/mln/value/gray.hh (revision 1471) +++ trunk/milena/mln/value/gray.hh (revision 1472) @@ -43,10 +43,21 @@ namespace mln { + namespace literal + { + /// \{ Fwd decls. + struct black_t; + struct white_t; + /// \} + } + + namespace value + { /// \{ Fwd decls. - namespace literal { struct black_t; struct white_t; } - namespace value { template <unsigned N> class graylevel; class gray; } + template <unsigned N> class graylevel; + class gray; /// \} + } namespace trait Index: trunk/milena/mln/value/int_s.hh =================================================================== --- trunk/milena/mln/value/int_s.hh (revision 1471) +++ trunk/milena/mln/value/int_s.hh (revision 1472) @@ -48,10 +48,20 @@ { + namespace value + { + /// \{ Fwd decls. + template <unsigned n> struct int_s; + /// \} + } + + namespace literal + { /// \{ Fwd decls. - namespace value { template <unsigned n> struct int_s; } - namespace literal { struct zero_t; struct one_t; } + struct zero_t; + struct one_t; /// \} + } Index: trunk/milena/mln/value/int_u.hh =================================================================== --- trunk/milena/mln/value/int_u.hh (revision 1471) +++ trunk/milena/mln/value/int_u.hh (revision 1472) @@ -49,10 +49,20 @@ namespace mln { + namespace value + { + /// \{ Fwd decls. + template <unsigned n> struct int_u; + /// \} + } + + namespace literal + { /// \{ Fwd decls. - namespace value { template <unsigned n> struct int_u; } - namespace literal { struct zero_t; struct one_t; } + struct zero_t; + struct one_t; /// \} + } namespace trait Index: trunk/milena/mln/value/rgb.hh =================================================================== --- trunk/milena/mln/value/rgb.hh (revision 1471) +++ trunk/milena/mln/value/rgb.hh (revision 1472) @@ -44,17 +44,17 @@ namespace mln { - /// \{ Fwd decls. namespace literal { + /// \{ Fwd decls. struct black_t; struct white_t; struct red_t; struct blue_t; struct green_t; - } /// \} + } namespace value Index: trunk/milena/mln/fun/p2b/all.hh =================================================================== --- trunk/milena/mln/fun/p2b/all.hh (revision 1471) +++ trunk/milena/mln/fun/p2b/all.hh (revision 1472) @@ -28,7 +28,7 @@ #ifndef MLN_FUN_P2B_ALL_HH # define MLN_FUN_P2B_ALL_HH -/*! \file mln/fun_p2b/all.hh +/*! \file mln/fun/p2b/all.hh * * \brief File that includes all functions from point to boolean. */ Index: trunk/milena/mln/util/branch_iter_ind.hh =================================================================== --- trunk/milena/mln/util/branch_iter_ind.hh (revision 1471) +++ trunk/milena/mln/util/branch_iter_ind.hh (revision 1472) @@ -25,18 +25,19 @@ // reasons why the executable file might be covered by the GNU General // Public License. -#ifndef MLN_UTIL_BRANCH_ITER_HH -# define MLN_UTIL_BRANCH_ITER_HH +#ifndef MLN_UTIL_BRANCH_ITER_IND_HH +# define MLN_UTIL_BRANCH_ITER_IND_HH -# include <stack> -# include <mln/util/tree.hh> /*! - * \file mln/util/branch.hh + * \file mln/util/branch_iter_ind.hh * * \brief Definition of a iterator on branch. * */ +# include <stack> +# include <mln/util/tree.hh> + namespace mln { @@ -59,14 +60,14 @@ /*! \brief Basic 2D image class. * - * The parameter \c T is the type of node's data. branch_iter is used to pre-order walk a branch. + * The parameter \c T is the type of node's data. branch_iter_ind is used to pre-order walk a branch. */ template <typename T> - class branch_iter + class branch_iter_ind { public: - branch_iter(branch<T> branch); + branch_iter_ind(branch<T> branch); /// Convertion to node. operator util::node<T>&() const; @@ -100,14 +101,14 @@ template <typename T> - branch_iter<T>::branch_iter(branch<T> branch) + branch_iter_ind<T>::branch_iter_ind(branch<T> branch) : branch_(branch) { invalidate(); } template <typename T> - branch_iter<T>::operator node<T>&() const + branch_iter_ind<T>::operator node<T>&() const { mln_assertion(n_); return *n_; @@ -115,7 +116,7 @@ template <typename T> util::node<T>& - branch_iter<T>::operator*() + branch_iter_ind<T>::operator*() { mln_assertion(n_); return *n_; @@ -123,7 +124,7 @@ template <typename T> unsigned - branch_iter<T>::deepness() const + branch_iter_ind<T>::deepness() const { mln_assertion(is_valid()); unsigned i = 0; @@ -138,14 +139,14 @@ template <typename T> bool - branch_iter<T>::is_valid() const + branch_iter_ind<T>::is_valid() const { return n_ != 0; } template <typename T> void - branch_iter<T>::invalidate() + branch_iter_ind<T>::invalidate() { n_ = 0; } @@ -153,7 +154,7 @@ template <typename T> void - branch_iter<T>::start() + branch_iter_ind<T>::start() { s_.push(bi_elt<T>(&branch_.apex().children())); @@ -162,7 +163,7 @@ template <typename T> void - branch_iter<T>::next() + branch_iter_ind<T>::next() { // First : list of children. // Second : i; @@ -218,4 +219,4 @@ } // end of namespace mln -#endif // !MLN_UTIL_BRANCH_HH +#endif // !MLN_UTIL_BRANCH_ITER_IND_HH Index: trunk/milena/mln/util/branch_iter.hh =================================================================== --- trunk/milena/mln/util/branch_iter.hh (revision 1471) +++ trunk/milena/mln/util/branch_iter.hh (revision 1472) @@ -28,15 +28,16 @@ #ifndef MLN_UTIL_BRANCH_ITER_HH # define MLN_UTIL_BRANCH_ITER_HH -# include <stack> -# include <mln/util/tree.hh> /*! - * \file mln/util/branch.hh + * \file mln/util/branch_iter.hh * * \brief Definition of a iterator on branch. * */ +# include <stack> +# include <mln/util/tree.hh> + namespace mln { Index: trunk/milena/sandbox/duhamel/labeling_level_generic_10000x1000.cc =================================================================== --- trunk/milena/sandbox/duhamel/labeling_level_generic_10000x1000.cc (revision 1471) +++ trunk/milena/sandbox/duhamel/labeling_level_generic_10000x1000.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/labeling_foreground.cc +/*! \file sandbox/duhamel/labeling_level_generic_10000x1000.cc * * \brief Test on mln::labeling::foreground. */ Index: trunk/milena/sandbox/duhamel/labeling_algo.cc =================================================================== --- trunk/milena/sandbox/duhamel/labeling_algo.cc (revision 1471) +++ trunk/milena/sandbox/duhamel/labeling_algo.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/labeling_foreground.cc +/*! \file sandbox/duhamel/labeling_algo.cc * * \brief Test on mln::labeling::foreground. */ Index: trunk/milena/sandbox/duhamel/color_sub.cc =================================================================== --- trunk/milena/sandbox/duhamel/color_sub.cc (revision 1471) +++ trunk/milena/sandbox/duhamel/color_sub.cc (revision 1472) @@ -25,9 +25,9 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/sub_image.cc +/*! \file sandbox/duhamel/color_sub.cc * - * \brief Tests on mln::sub_image. + * \brief Tests on mln::color_sub. */ # include <mln/core/image2d_b.hh> Index: trunk/milena/sandbox/duhamel/labeling_level_fast_10000x1000.cc =================================================================== --- trunk/milena/sandbox/duhamel/labeling_level_fast_10000x1000.cc (revision 1471) +++ trunk/milena/sandbox/duhamel/labeling_level_fast_10000x1000.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/labeling_foreground.cc +/*! \file sandbox/duhamel/labeling_level_fast_10000x1000.cc * * \brief Test on mln::labeling::foreground. */ Index: trunk/milena/sandbox/duhamel/labeling_level_fast.cc =================================================================== --- trunk/milena/sandbox/duhamel/labeling_level_fast.cc (revision 1471) +++ trunk/milena/sandbox/duhamel/labeling_level_fast.cc (revision 1472) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/labeling_foreground.cc +/*! \file sandbox/duhamel/labeling_level_fast.cc * * \brief Test on mln::labeling::foreground. */ Index: trunk/milena/sandbox/duhamel/labeling_level.hh =================================================================== --- trunk/milena/sandbox/duhamel/labeling_level.hh (revision 1471) +++ trunk/milena/sandbox/duhamel/labeling_level.hh (revision 1472) @@ -28,7 +28,7 @@ #ifndef SANDBOX_MLN_LABELING_LEVEL_HH # define SANDBOX_MLN_LABELING_LEVEL_HH -/*! \file mln/labeling/level.hh +/*! \file sandbox/duhamel/labeling_level.hh * * \brief Connected component labeling of the image objects at a given * level. Index: trunk/milena/sandbox/garrigues/fllt2.hh =================================================================== --- trunk/milena/sandbox/garrigues/fllt2.hh (revision 1471) +++ trunk/milena/sandbox/garrigues/fllt2.hh (revision 1472) @@ -99,7 +99,7 @@ # define fllt_tree(P, V) util::tree< fllt_node_elt<P, V> > # define fllt_node(P, V) util::node< fllt_node_elt<P, V> > # define fllt_branch(P, V) util::branch< fllt_node_elt<P, V> > -# define fllt_branch_iter(P, V) util::branch_iter< fllt_node_elt<P, V> > +# define fllt_branch_iter_ind(P, V) util::branch_iter_ind< fllt_node_elt<P, V> > // # define fllt_node(P, V) typename fllt_tree(P, V)::node_t @@ -690,7 +690,7 @@ { std::cout << "[Merge first tree]------------" << std::endl; - fllt_branch_iter(P, V) p(lower_tree.main_branch()); + fllt_branch_iter_ind(P, V) p(lower_tree.main_branch()); for_all(p) { fllt_node(P, V)& n(p); @@ -704,7 +704,7 @@ { std::cout << "[Merge second tree]------------" << std::endl; - fllt_branch_iter(P, V) p(upper_tree.main_branch()); + fllt_branch_iter_ind(P, V) p(upper_tree.main_branch()); for_all(p) { fllt_node(P, V)& n(p); @@ -739,7 +739,7 @@ visualize_deepness(image2d<value::int_u8>& output, fllt_tree(P, V)& tree) { - fllt_branch_iter(P, V) p(tree.main_branch()); + fllt_branch_iter_ind(P, V) p(tree.main_branch()); level::fill(output, 0); for_all(p) { @@ -760,7 +760,7 @@ fllt_tree(P, V)& tree, unsigned limit) { - fllt_branch_iter(P, V) p(tree.main_branch()); + fllt_branch_iter_ind(P, V) p(tree.main_branch()); level::fill(output, 255); for_all(p) { @@ -786,7 +786,7 @@ draw_tree(const image2d<V>& ima, fllt_tree(P, V)& tree) { - fllt_branch_iter(P, V) p(tree.main_branch()); + fllt_branch_iter_ind(P, V) p(tree.main_branch()); for_all(p) { std::cout << "region mere : " << (*p).parent() << std::endl;