[Olena-patches] cleanup-2008 r2224: Fix most of Doxygen's warnings

URL: https://svn.lrde.epita.fr/svn/oln/branches/cleanup-2008/milena ChangeLog: 2008-09-11 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; Fix most of Doxygen's warnings. * milena/mln/core/image/flat_image.hh, * milena/mln/core/internal/site_relative_iterator_base.hh, * milena/mln/core/site_set/line2d.hh, * milena/mln/core/site_set/p_if_piter.hh, * milena/mln/core/site_set/p_priority.hh, * milena/mln/trait/image/props.hh, * milena/mln/util/internal/boost_graph_structure.hh, * milena/mln/util/internal/graph_base.hh, * milena/tests/algebra/h_vec.cc, * milena/tests/binarization/threshold.cc, * milena/tests/core/image/flat_image.cc, * milena/tests/core/image/tr_image.cc, * milena/tests/core/other/dpoints_pixter.cc, * milena/tests/core/site_set/p_priority_queue.cc, * milena/tests/core/site_set/p_priority_queue_fast.cc, * milena/tests/core/site_set/p_priority_queue_fast_with_array.cc, * milena/tests/core/site_set/pset_array.cc, * milena/tests/core/site_set/pset_if.cc, * milena/tests/level/sort_psites_full.cc, * milena/tests/morpho/line_graph_image_wst.cc, * milena/tests/morpho/meyer_wst.cc, * milena/tests/morpho/meyer_wst_long.cc, * milena/tests/test/positive.cc, * milena/tests/value/builtin/builtin.cc: Fix \file tag with the proper file name. * milena/doc/Doxyfile.in: Add new macro expansions. * milena/doc/Makefile.am: set EXCLUDE_SYMBOLS properly when making the user doc. --- doc/Doxyfile.in | 11 ++++++++++- doc/Makefile.am | 5 ++++- mln/core/image/flat_image.hh | 2 +- mln/core/internal/site_relative_iterator_base.hh | 2 +- mln/core/site_set/line2d.hh | 2 +- mln/core/site_set/p_if_piter.hh | 2 +- mln/core/site_set/p_priority.hh | 2 +- mln/trait/image/props.hh | 4 ++++ mln/util/internal/boost_graph_structure.hh | 2 +- mln/util/internal/graph_base.hh | 2 +- tests/algebra/h_vec.cc | 2 +- tests/binarization/threshold.cc | 2 +- tests/core/image/flat_image.cc | 2 +- tests/core/image/tr_image.cc | 2 +- tests/core/other/dpoints_pixter.cc | 2 +- tests/core/site_set/p_priority_queue.cc | 2 +- tests/core/site_set/p_priority_queue_fast.cc | 2 +- tests/core/site_set/p_priority_queue_fast_with_array.cc | 4 ++-- tests/core/site_set/pset_array.cc | 2 +- tests/core/site_set/pset_if.cc | 2 +- tests/level/sort_psites_full.cc | 2 +- tests/morpho/line_graph_image_wst.cc | 2 +- tests/morpho/meyer_wst.cc | 2 +- tests/morpho/meyer_wst_long.cc | 2 +- tests/test/positive.cc | 2 +- tests/value/builtin/builtin.cc | 2 +- 26 files changed, 42 insertions(+), 26 deletions(-) Index: branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue_fast.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue_fast.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue_fast.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/core/site_set/p_priority_fast.cc +/*! \file tests/core/site_set/p_priority_queue_fast.cc * * \brief Tests on mln::p_priority_fast. */ Index: branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/core/site_set/p_priority.cc +/*! \file tests/core/site_set/p_priority_queue.cc * * \brief Tests on mln::p_priority. */ Index: branches/cleanup-2008/milena/tests/core/site_set/pset_array.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/site_set/pset_array.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/site_set/pset_array.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file mln/core/pset_array.hh +/*! \file tests/core/site_set/pset_array.cc * * \brief Tests for the pset array. */ Index: branches/cleanup-2008/milena/tests/core/site_set/pset_if.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/site_set/pset_if.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/site_set/pset_if.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/core/site_set/p_if.cc +/*! \file tests/core/site_set/pset_if.cc * * \brief Tests on mln::p_if. */ Index: branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue_fast_with_array.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue_fast_with_array.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/site_set/p_priority_queue_fast_with_array.cc (revision 2224) @@ -25,13 +25,13 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/core/site_set/p_priority_fast_with_array.cc +/*! \file tests/core/site_set/p_priority_queue_fast_with_array.cc * * \brief Tests on mln::p_priority_fast_with_array. */ #include <mln/core/alias/point2d.hh> -#include <mln/core/p_priority_fast_with_array.hh> +#include <mln/core/p_priority_queue_fast_with_array.hh> int main () { Index: branches/cleanup-2008/milena/tests/core/other/dpoints_pixter.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/other/dpoints_pixter.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/other/dpoints_pixter.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/dpoints_pixter.cc +/// \file tests/core/other/dpoints_pixter.cc /// \brief Test on mln::dpoints_fwd_pixter and mln::dpoints_bkd_pixter. #include <mln/core/image/image1d.hh> Index: branches/cleanup-2008/milena/tests/core/image/tr_image.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/image/tr_image.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/image/tr_image.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/tr_image.cc +/*! \file tests/core/image/tr_image.cc * * \brief Tests on mln::tr_image. */ Index: branches/cleanup-2008/milena/tests/core/image/flat_image.cc =================================================================== --- branches/cleanup-2008/milena/tests/core/image/flat_image.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/core/image/flat_image.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/core/flat_image.cc +/*! \file tests/core/image/flat_image.cc * * \brief Tests on mln::flat_image. */ Index: branches/cleanup-2008/milena/tests/level/sort_psites_full.cc =================================================================== --- branches/cleanup-2008/milena/tests/level/sort_psites_full.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/level/sort_psites_full.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/level/sort_points_full.cc +/*! \file tests/level/sort_psites_full.cc * * \brief Tests on mln::level::sort_points. */ Index: branches/cleanup-2008/milena/tests/value/builtin/builtin.cc =================================================================== --- branches/cleanup-2008/milena/tests/value/builtin/builtin.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/value/builtin/builtin.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/value/builtin.cc +/*! \file tests/value/builtin/builtin.cc * * \brief Tests on mln::trait::op with a builtin. */ Index: branches/cleanup-2008/milena/tests/test/positive.cc =================================================================== --- branches/cleanup-2008/milena/tests/test/positive.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/test/positive.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/test/test_positive.cc +/*! \file tests/test/positive.cc * * \brief Tests on mln::test::positive. */ Index: branches/cleanup-2008/milena/tests/binarization/threshold.cc =================================================================== --- branches/cleanup-2008/milena/tests/binarization/threshold.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/binarization/threshold.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/binarization/thresholding.cc +/// \file tests/binarization/threshold.cc /// \brief Test on mln::binarization::threshold. #include <mln/core/image/image2d.hh> Index: branches/cleanup-2008/milena/tests/algebra/h_vec.cc =================================================================== --- branches/cleanup-2008/milena/tests/algebra/h_vec.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/algebra/h_vec.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/h_vec.cc +/*! \file tests/algebra/h_vec.cc * * \brief Tests on mln::algebra::h_vec. */ Index: branches/cleanup-2008/milena/tests/morpho/meyer_wst_long.cc =================================================================== --- branches/cleanup-2008/milena/tests/morpho/meyer_wst_long.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/morpho/meyer_wst_long.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/morpho/extrema_components.cc +/// \file tests/morpho/meyer_wst_long.cc // /\brief Test on mln::morpho::extrema_components #include <iostream> Index: branches/cleanup-2008/milena/tests/morpho/line_graph_image_wst.cc =================================================================== --- branches/cleanup-2008/milena/tests/morpho/line_graph_image_wst.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/morpho/line_graph_image_wst.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/core/line_graph_image.cc +/// \file tests/morpho/line_graph_image_wst.cc /// \brief Tests on the Watershed Transform on a mln::line_graph_image. #include <vector> Index: branches/cleanup-2008/milena/tests/morpho/meyer_wst.cc =================================================================== --- branches/cleanup-2008/milena/tests/morpho/meyer_wst.cc (revision 2223) +++ branches/cleanup-2008/milena/tests/morpho/meyer_wst.cc (revision 2224) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/// \file tests/morpho/extrema_components.cc +/// \file tests/morpho/meyer_wst.cc // /\brief Test on mln::morpho::extrema_components #include <iostream> Index: branches/cleanup-2008/milena/doc/Doxyfile.in =================================================================== --- branches/cleanup-2008/milena/doc/Doxyfile.in (revision 2223) +++ branches/cleanup-2008/milena/doc/Doxyfile.in (revision 2224) @@ -82,6 +82,7 @@ EXCLUDE = @top_srcdir@/milena/sandbox EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *spe.hh +EXCLUDE_SYMBOLS = EXAMPLE_PATH = EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO @@ -210,7 +211,15 @@ "mln_mesh(T)=typename T::mesh" \ "mln_coord(T)=typename T::coord" \ "mln_point(T)=typename T::point" \ - "mln_dpoint(T)=typename T::dpoint" + "mln_dpoint(T)=typename T::dpoint" \ + "mln_accu_with(A, T)=typename A::template with< T >::ret" \ + "mln_trait_op_plus(L, R)=typename mln::trait::op::plus< L , R >::ret" \ + "mln_trait_op_minus(L, R)=typename mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_times(L, R)=typename mln::trait::op::times< L , R >::ret" \ + "mln_trait_op_div(L, R)=typename mln::trait::op::div< L , R >::ret" \ + "mln_trait_op_mod(L, R)=typename mln::trait::op::mod< L , R >::ret" \ + "mln_trait_op_uminus(T)=typename mln::trait::op::uminus< T >::ret" + EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- Index: branches/cleanup-2008/milena/doc/Makefile.am =================================================================== --- branches/cleanup-2008/milena/doc/Makefile.am (revision 2223) +++ branches/cleanup-2008/milena/doc/Makefile.am (revision 2224) @@ -40,7 +40,10 @@ -e 's,HIDE_IN_BODY_DOCS = NO,HIDE_IN_BODY_DOCS = YES,g' \ -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,PROJECT_NUMBER = \",PROJECT_NUMBER = \"User documentation ,g' \ + -e 's,EXCLUDE_SYMBOLS =,EXCLUDE_SYMBOLS = mln::internal::*,g' + + EXTRA_DIST = Doxyfile.in Index: branches/cleanup-2008/milena/mln/trait/image/props.hh =================================================================== --- branches/cleanup-2008/milena/mln/trait/image/props.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/trait/image/props.hh (revision 2224) @@ -104,6 +104,8 @@ // \ | // -- + -- cell_and_value_wise +// * domain values + // value_io: /any/ // | // + -- read_only @@ -152,6 +154,8 @@ // | // + -- extendable +// * extension values + // ext_value: /any/ // | // + -- irrelevant Index: branches/cleanup-2008/milena/mln/core/site_set/p_priority.hh =================================================================== --- branches/cleanup-2008/milena/mln/core/site_set/p_priority.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/core/site_set/p_priority.hh (revision 2224) @@ -28,7 +28,7 @@ #ifndef MLN_CORE_P_PRIORITY_HH # define MLN_CORE_P_PRIORITY_HH -/*! \file mln/core/p_priority.hh +/*! \file mln/core/site_set/p_priority.hh * * \brief Definition of a priority queue of sites. * Index: branches/cleanup-2008/milena/mln/core/site_set/line2d.hh =================================================================== --- branches/cleanup-2008/milena/mln/core/site_set/line2d.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/core/site_set/line2d.hh (revision 2224) @@ -28,7 +28,7 @@ #ifndef MLN_CORE_P_LINE2D_HH # define MLN_CORE_P_LINE2D_HH -/*! \file mln/core/p_line2d.hh +/*! \file mln/core/site_set/line2d.hh * * \brief Definition of a 2D discrete line of points (based on * p_array). Index: branches/cleanup-2008/milena/mln/core/site_set/p_if_piter.hh =================================================================== --- branches/cleanup-2008/milena/mln/core/site_set/p_if_piter.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/core/site_set/p_if_piter.hh (revision 2224) @@ -28,7 +28,7 @@ #ifndef MLN_CORE_SITE_SET_P_IF_PITER_HH # define MLN_CORE_SITE_SET_P_IF_PITER_HH -/*! \file mln/core/p_if_piter.hh +/*! \file mln/core/site_set/p_if_piter.hh * * \brief Definition of iterators on p_if<S,F>. */ Index: branches/cleanup-2008/milena/mln/core/image/flat_image.hh =================================================================== --- branches/cleanup-2008/milena/mln/core/image/flat_image.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/core/image/flat_image.hh (revision 2224) @@ -29,7 +29,7 @@ # define MLN_CORE_FLAT_IMAGE_HH /*! - * \file mln/core/flat_image.hh + * \file mln/core/image/flat_image.hh * * \brief Definition of a image with a signle value. * Index: branches/cleanup-2008/milena/mln/core/internal/site_relative_iterator_base.hh =================================================================== --- branches/cleanup-2008/milena/mln/core/internal/site_relative_iterator_base.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/core/internal/site_relative_iterator_base.hh (revision 2224) @@ -28,7 +28,7 @@ #ifndef MLN_CORE_SITE_RELATIVE_ITERATOR_BASE_HH # define MLN_CORE_SITE_RELATIVE_ITERATOR_BASE_HH -/*! \file mln/core/site_relative_iterator_base.hh +/*! \file mln/core/internal/site_relative_iterator_base.hh * * \brief Definition of forward and backward mln::dpoint_ based * iterators. Index: branches/cleanup-2008/milena/mln/util/internal/boost_graph_structure.hh =================================================================== --- branches/cleanup-2008/milena/mln/util/internal/boost_graph_structure.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/util/internal/boost_graph_structure.hh (revision 2224) @@ -26,7 +26,7 @@ // Public License. -/// \file mln/util/internal/boost_graph_struture.hh +/// \file mln/util/internal/boost_graph_structure.hh /// \brief Operations that interract with the boost_graph structure. #ifndef MLN_UTIL_INTERNAL_BOOST_GRAPH_STRUCTURE_HH_ Index: branches/cleanup-2008/milena/mln/util/internal/graph_base.hh =================================================================== --- branches/cleanup-2008/milena/mln/util/internal/graph_base.hh (revision 2223) +++ branches/cleanup-2008/milena/mln/util/internal/graph_base.hh (revision 2224) @@ -28,7 +28,7 @@ #ifndef MLN_UTIL_INTERNAL_GRAPH_BASE_HH # define MLN_UTIL_INTERNAL_GRAPH_BASE_HH -/// \file mln/util/internal/graph.hh +/// \file mln/util/internal/graph_base.hh /// \brief Factored implementation of undirected graphs. # include <cstddef>