[Olena-patches] olena: olena-2.0-601-g0a09504 Small fixes in documentation.

* doc/mln/core/image/morphers.dox: Add a reference to duplicate(). * mln/core/pixter1d.hh: Remove \internal commands. * mln/data/transform.hh: Improve layout of pseudo-code. * mln/io/pdf/load.hh: Remove duplicate '*' in comments. --- milena/ChangeLog | 12 +++++++ milena/doc/mln/core/image/morphers.dox | 9 +++-- milena/mln/core/pixter1d.hh | 2 - milena/mln/data/transform.hh | 51 ++++++++++++++++++-------------- milena/mln/io/pdf/load.hh | 12 ++++---- 5 files changed, 52 insertions(+), 34 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 62b5772..d5b38b1 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,17 @@ 2013-04-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Small fixes in documentation. + + * doc/mln/core/image/morphers.dox: Add a reference to duplicate(). + + * mln/core/pixter1d.hh: Remove \internal commands. + + * mln/data/transform.hh: Improve layout of pseudo-code. + + * mln/io/pdf/load.hh: Remove duplicate '*' in comments. + +2013-04-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Improve documentation of several macros. * mln/core/concept/iterator.hh: Document arguments. diff --git a/milena/doc/mln/core/image/morphers.dox b/milena/doc/mln/core/image/morphers.dox index 5354898..290a0a6 100644 --- a/milena/doc/mln/core/image/morphers.dox +++ b/milena/doc/mln/core/image/morphers.dox @@ -1,6 +1,7 @@ /*! \defgroup modimagemorpher Image morphers - * - * \brief Morpher on both image values and domain. - * - * \ingroup modimage + + \brief Morpher on both image values and domain. + + \sa mln::duplicate + \ingroup modimage */ diff --git a/milena/mln/core/pixter1d.hh b/milena/mln/core/pixter1d.hh index 0b15ae3..8c76129 100644 --- a/milena/mln/core/pixter1d.hh +++ b/milena/mln/core/pixter1d.hh @@ -42,7 +42,6 @@ namespace mln `------------------*/ /*! - \internal \brief Forward pixel iterator on a 1-D image with border. */ template <typename I> @@ -71,7 +70,6 @@ namespace mln `------------------*/ /*! - \internal \brief Backward pixel iterator on a 1-D image with border. */ template <typename I> diff --git a/milena/mln/data/transform.hh b/milena/mln/data/transform.hh index be425a4..ee58e49 100644 --- a/milena/mln/data/transform.hh +++ b/milena/mln/data/transform.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -50,31 +50,38 @@ namespace mln { /*! \brief Transform the image \p input through a function \p f. - * - * \param[in] input The input image. - * \param[in] f The function. - * - * This routine runs: \n - * for all p of \p input, \p output(p) = \p f( \p input(p) ). - * - * \ingroup mlndata - */ + + \param[in] input The input image. + \param[in] f The function. + + This routine runs: + \verbatim + for all p of input + output(p) = f( input(p) ) + \endverbatim + + \ingroup mlndata + */ template <typename I, typename F> mln_ch_value(I, mln_result(F)) transform(const Image<I>& input, const Function_v2v<F>& f); - /*! \brief Transform two images \p input1 \p input2 through a function \p f. - * - * \param[in] input1 The 1st input image. - * \param[in] input2 The 2nd input image. - * \param[in] f The function. - * - * This routine runs: \n - * for all p of \p input, \p output(p) = \p f( \p input1(p), \p input2(p) ). - * - * \ingroup mlndata - */ + /*! \brief Transform two images \p input1 \p input2 through a + function \p f. + + \param[in] input1 The 1st input image. + \param[in] input2 The 2nd input image. + \param[in] f The function. + + This routine runs: + \verbatim + for all p of input + output(p) = f( input1(p), input2(p) ) + \endverbatim + + \ingroup mlndata + */ template <typename I1, typename I2, typename F> mln_ch_value(I1, mln_result(F)) transform(const Image<I1>& input1, diff --git a/milena/mln/io/pdf/load.hh b/milena/mln/io/pdf/load.hh index 84e0926..c0255a8 100644 --- a/milena/mln/io/pdf/load.hh +++ b/milena/mln/io/pdf/load.hh @@ -45,7 +45,7 @@ namespace mln namespace pdf { - /**! \brief Load a multiple page PDF document using libpoppler. + /*! \brief Load a multiple page PDF document using libpoppler. \param[out] arr An array of images. \param[in] filename The name of the input file. @@ -59,7 +59,7 @@ namespace mln void load(util::array<I>& arr, const std::string& filename, float dpi); - /**! \overload + /*! \overload \brief Load a range of pages from a PDF document using libpoppler. @@ -79,7 +79,7 @@ namespace mln int first_page, int last_page, float dpi); - /**! \overload + /*! \overload \brief Load specific pages from a PDF document using libpoppler. @@ -97,7 +97,7 @@ namespace mln void load(util::array<I>& arr, const std::string& filename, util::array<int> pages, float dpi); - /**! \overload + /*! \overload \brief Load a specific page from a PDF document using libpoppler. @@ -116,7 +116,7 @@ namespace mln int page, float dpi); - /**! \overload + /*! \overload \brief Load a multiple page PDF document using libpoppler. @@ -131,7 +131,7 @@ namespace mln template <typename I> void load(util::array<I>& arr, const std::string& filename); - /**! \overload + /*! \overload \brief Load specific pages from a PDF document using libpoppler. -- 1.7.2.5