[Olena-patches] milena r1618: Reduce warnings for Doxygen

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena $ make user-doc 2> err.log $ cat err.log | wc -l 131 ChangeLog: 2007-12-18 Guillaume Duhamel &lt;guillaume.duhamel(a)lrde.epita.fr&gt; Reduce warnings for Doxygen. * doc/examples/labeling_algo.cc, * mln/core/mesh_image.hh, * mln/core/mesh_psite.hh, * mln/debug/iota.hh, * mln/geom/seeds2tiling.hh, * mln/geom/seeds2tiling_roundness.hh, * mln/morpho/top_hat.hh, * mln/pw/image.hh, * mln/util/tree.hh, * mln/util/tree_to_image.hh, * tests/fun/v2v/norm.cc: Fix some Doxygen warnings for these files. --- doc/examples/labeling_algo.cc | 2 +- mln/core/mesh_image.hh | 2 +- mln/core/mesh_psite.hh | 7 +++++-- mln/debug/iota.hh | 2 +- mln/geom/seeds2tiling.hh | 4 ++-- mln/geom/seeds2tiling_roundness.hh | 4 ++-- mln/pw/image.hh | 2 +- mln/util/tree.hh | 3 ++- mln/util/tree_to_image.hh | 6 +++--- tests/fun/v2v/norm.cc | 2 +- 10 files changed, 19 insertions(+), 15 deletions(-) Index: trunk/milena/tests/fun/v2v/norm.cc =================================================================== --- trunk/milena/tests/fun/v2v/norm.cc (revision 1617) +++ trunk/milena/tests/fun/v2v/norm.cc (revision 1618) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/norm/l1.hh +/*! \file tests/fun/v2v/norm.cc * * \brief Test the norm functors. */ Index: trunk/milena/doc/examples/labeling_algo.cc =================================================================== --- trunk/milena/doc/examples/labeling_algo.cc (revision 1617) +++ trunk/milena/doc/examples/labeling_algo.cc (revision 1618) @@ -25,7 +25,7 @@ // reasons why the executable file might be covered by the GNU General // Public License. -/*! \file tests/labeling_algo.cc +/*! \file doc/examples/labeling_algo.cc * * \brief Test on mln::geom::seeds2tiling. */ Index: trunk/milena/mln/debug/iota.hh =================================================================== --- trunk/milena/mln/debug/iota.hh (revision 1617) +++ trunk/milena/mln/debug/iota.hh (revision 1618) @@ -47,7 +47,7 @@ /*! Fill the image \p input with successive values. * - * \param[in,out] destination The image in which values are + * \param[in,out] input The image in which values are * assigned. */ template <typename I> Index: trunk/milena/mln/core/mesh_psite.hh =================================================================== --- trunk/milena/mln/core/mesh_psite.hh (revision 1617) +++ trunk/milena/mln/core/mesh_psite.hh (revision 1618) @@ -45,8 +45,11 @@ template<typename P> class mesh_p; - // FIXME: Doc! - // FIXME: Fix access to member. + /*! + * \brief Point site associate to mesh_image. + * + * \todo Fix access to member. + */ template<typename P> class mesh_psite : public Point_Site< mesh_psite<P> > { Index: trunk/milena/mln/core/mesh_image.hh =================================================================== --- trunk/milena/mln/core/mesh_image.hh (revision 1617) +++ trunk/milena/mln/core/mesh_image.hh (revision 1618) @@ -86,7 +86,7 @@ } // end of namespace mln::trait - /*! \brief FIXME + /*! \brief Kind of image based on graph structure. * */ template <typename P, typename V> Index: trunk/milena/mln/pw/image.hh =================================================================== --- trunk/milena/mln/pw/image.hh (revision 1617) +++ trunk/milena/mln/pw/image.hh (revision 1618) @@ -168,7 +168,7 @@ namespace internal { - + /// \internal template <typename F, typename S> inline data_< pw::image<F,S> >::data_(const F& f, const S& ps) Index: trunk/milena/mln/geom/seeds2tiling_roundness.hh =================================================================== --- trunk/milena/mln/geom/seeds2tiling_roundness.hh (revision 1617) +++ trunk/milena/mln/geom/seeds2tiling_roundness.hh (revision 1618) @@ -53,12 +53,12 @@ /*! Take a labeled image \p ima_ with seeds and extend them until * creating tiles nore roundness that the primary version. * - * \param[in,out] ima The labeled image with seed. + * \param[in,out] ima_ The labeled image with seed. * \param[in] win_w The weight window using by geom::chamfer to compute distance. * \param[in] max Unsigned using by geom::chamfer to compute distance. * \param[in] nbh The neighborhood to use on this algorithm. * - * \pre \p ima has to be initialized. + * \pre \p ima_ has to be initialized. * */ template <typename I, typename N> Index: trunk/milena/mln/geom/seeds2tiling.hh =================================================================== --- trunk/milena/mln/geom/seeds2tiling.hh (revision 1617) +++ trunk/milena/mln/geom/seeds2tiling.hh (revision 1618) @@ -50,10 +50,10 @@ /*! Take a labeled image \p ima_ with seeds and extend them * until creating tiles. * - * \param[in,out] ima The labeled image with seed. + * \param[in,out] ima_ The labeled image with seed. * \param[in] nbh The neighborhood to use on this algorithm. * - * \pre \p ima has to be initialized. + * \pre \p ima_ has to be initialized. * */ template <typename I, typename N> Index: trunk/milena/mln/morpho/top_hat.hh =================================================================== Index: trunk/milena/mln/util/tree.hh =================================================================== --- trunk/milena/mln/util/tree.hh (revision 1617) +++ trunk/milena/mln/util/tree.hh (revision 1618) @@ -130,7 +130,7 @@ /*! \brief Bind \p node to the current node and become its * parent. * - * \param[in] node The new parent node. + * \param[in] parent The new parent node. * */ void set_parent(node<T>* parent); @@ -144,6 +144,7 @@ * node as root. * * \param[in] ostr The output stream. + * \param[in] level The deep level * */ void print(std::ostream& ostr, int level = 0); Index: trunk/milena/mln/util/tree_to_image.hh =================================================================== --- trunk/milena/mln/util/tree_to_image.hh (revision 1617) +++ trunk/milena/mln/util/tree_to_image.hh (revision 1618) @@ -45,7 +45,7 @@ namespace util { - /*! Convert a tree into an image. + /*! \brief Convert a tree into an image. * * \param[in] tree The tree to convert. * \param[out] output_ The image containing tree informations. @@ -57,7 +57,7 @@ /*! Display a tree. * - * \param[in] ima The domain of output image. + * \param[in] ima_ The domain of output image. * \param[in] tree The tree to display. * */ @@ -68,7 +68,7 @@ /*! Display an arborescence from \p node. * - * \param[in] ima The domain of output image. + * \param[in] ima_ The domain of output image. * \param[in] node The root node to display. * */