[Olena-patches] olena-2.0-74-g4869c40 Fix doxygen warnings.

* mln/accu/compute.hh, * mln/convert/to_p_set.hh, * mln/data/compute.hh, * mln/debug/filename.hh, * mln/labeling/blobs.hh, * mln/morpho/tree/filter/all.hh: Here. --- milena/ChangeLog | 11 +++++++++++ milena/mln/accu/compute.hh | 4 ++-- milena/mln/convert/to_p_set.hh | 2 +- milena/mln/data/compute.hh | 12 +++++++----- milena/mln/debug/filename.hh | 4 ++-- milena/mln/labeling/blobs.hh | 10 +++++----- milena/mln/morpho/tree/filter/all.hh | 5 +++-- 7 files changed, 31 insertions(+), 17 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 2454245..bb6b125 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,14 @@ +2011-12-07 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + + Fix doxygen warnings. + + * mln/accu/compute.hh, + * mln/convert/to_p_set.hh, + * mln/data/compute.hh, + * mln/debug/filename.hh, + * mln/labeling/blobs.hh, + * mln/morpho/tree/filter/all.hh: Here. + 2011-11-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; * mln/accu/math/sumpow.hh: New accumulator. diff --git a/milena/mln/accu/compute.hh b/milena/mln/accu/compute.hh index 9c0e6b1..bf513f9 100644 --- a/milena/mln/accu/compute.hh +++ b/milena/mln/accu/compute.hh @@ -46,8 +46,8 @@ namespace mln /// Make an accumulator compute the pixels of the image \p input. /// - /// \param[in] input The input image. /// \param[in] a An accumulator. + /// \param[in] input The input image. /// /// This routine runs: \n /// a.take(make::pix(input, p)); @@ -62,8 +62,8 @@ namespace mln /// Make an accumulator compute the pixels of the image \p input. /// - /// \param[in] input The input image. /// \param[in] a A meta accumulator. + /// \param[in] input The input image. /// /// This routine runs: \n /// a.take(make::pix(input, p)); diff --git a/milena/mln/convert/to_p_set.hh b/milena/mln/convert/to_p_set.hh index 3f5f8c4..46cd5e7 100644 --- a/milena/mln/convert/to_p_set.hh +++ b/milena/mln/convert/to_p_set.hh @@ -69,7 +69,7 @@ namespace mln p_set<P> to_p_set(const std::set<P, C>& s); - /// Convert any site set \p ps into a 'mln::p_set' site set. + /// Convert any site set \p ps into a 'mln::p_set<>' site set. template <typename S> p_set<mln_psite(S)> to_p_set(const Site_Set<S>& ps); diff --git a/milena/mln/data/compute.hh b/milena/mln/data/compute.hh index 0ab146e..6fe4925 100644 --- a/milena/mln/data/compute.hh +++ b/milena/mln/data/compute.hh @@ -42,9 +42,9 @@ namespace mln namespace data { - /// Compute an accumulator onto the pixel values of the image \p input. - /// Be ware that the given accumulator won't be modified and won't - /// store any result. + /// \brief Compute an accumulator onto the pixel values of the + /// image \p input. Be ware that the given accumulator won't be + /// modified and won't store any result. /// /// \param[in] a An accumulator. /// \param[in] input The input image. @@ -57,7 +57,8 @@ namespace mln compute(const Accumulator<A>& a, const Image<I>& input); - /// Compute an accumulator onto the pixel values of the image \p input. + /// \brief Compute an accumulator onto the pixel values of the + /// image \p input. /// /// \param[in, out] a An accumulator. /// \param[in] input The input image. @@ -70,7 +71,8 @@ namespace mln compute(Accumulator<A>& a, const Image<I>& input); - /// Compute an accumulator onto the pixel values of the image \p input. + /// \brief Compute an accumulator onto the pixel values of the + /// image \p input. /// /// \param[in] a A meta-accumulator. /// \param[in] input The input image. diff --git a/milena/mln/debug/filename.hh b/milena/mln/debug/filename.hh index 1fc268b..954e516 100644 --- a/milena/mln/debug/filename.hh +++ b/milena/mln/debug/filename.hh @@ -50,9 +50,9 @@ namespace mln ** ** Where: ** - `filename_prefix` can be set through the global variable - ** debug::internal::filename_prefix. + ** debug::internal::filename_prefix. ** - `postfix_id` is autoincremented by default. Its value can be - forced. + forced. ** - `filename` is the given filename */ std::string diff --git a/milena/mln/labeling/blobs.hh b/milena/mln/labeling/blobs.hh index 12462c8..ce06b7d 100644 --- a/milena/mln/labeling/blobs.hh +++ b/milena/mln/labeling/blobs.hh @@ -48,11 +48,11 @@ namespace mln namespace labeling { - /// Connected component labeling of the binary objects of a binary - /// image. + /// \brief Connected component labeling of the binary objects of a + /// binary image. /// - /// \param[in] input The input image. - /// \param[in] nbh The connexity of the objects. + /// \param[in] input The input image. + /// \param[in] nbh The connexity of the objects. /// \param[out] nlabels The Number of labels. Its value is set in the /// algorithms. /// \return The label image. @@ -61,7 +61,7 @@ namespace mln /// /// A fast queue is used so that the algorithm is not recursive and /// can handle large binary objects (blobs). - /// + // template <typename I, typename N, typename L> mln_ch_value(I, L) blobs(const Image<I>& input, const Neighborhood<N>& nbh, diff --git a/milena/mln/morpho/tree/filter/all.hh b/milena/mln/morpho/tree/filter/all.hh index 1271b06..97b0e92 100644 --- a/milena/mln/morpho/tree/filter/all.hh +++ b/milena/mln/morpho/tree/filter/all.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -27,7 +28,7 @@ # define MLN_MORPHO_TREE_FILTER_ALL_HH /** -** \file mln/morpho/tree/filter.hh +** \file ** ** Methods to handle component tree filtering strategies with ** non-increasing attribute. Nevertheless, it works on increasing -- 1.7.2.5