[Olena-patches] milena r1477: Fix differences between documented arguments and function arguments

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena ChangeLog: 2007-11-13 Matthieu Garrigues &lt;garrigues(a)lrde.epita.fr&gt; Fix differences between documented arguments and function arguments. * mln/labeling/estimate.hh, * mln/labeling/regional_maxima.hh, * mln/labeling/regional_minima.hh, * mln/level/memcpy_.hh, * mln/make/image2d.hh, * mln/make/point1d.hh, * mln/win/octagon2d.hh: Fix. --- labeling/estimate.hh | 1 + labeling/regional_maxima.hh | 1 + labeling/regional_minima.hh | 1 + level/memcpy_.hh | 2 +- make/image2d.hh | 2 +- make/point1d.hh | 3 +-- win/octagon2d.hh | 2 +- 7 files changed, 7 insertions(+), 5 deletions(-) Index: trunk/milena/mln/level/memcpy_.hh =================================================================== --- trunk/milena/mln/level/memcpy_.hh (revision 1476) +++ trunk/milena/mln/level/memcpy_.hh (revision 1477) @@ -49,7 +49,7 @@ * starting from pixel \p dest. * * \param[in,out] dest The destination pixel (to set values). - * \param[in] v The source pixel (to get values). + * \param[in] src The source pixel (to get values). * \param[in] n The number of pixels to copy. * * \pre FIXME: ! Index: trunk/milena/mln/make/image2d.hh =================================================================== --- trunk/milena/mln/make/image2d.hh (revision 1476) +++ trunk/milena/mln/make/image2d.hh (revision 1477) @@ -44,7 +44,7 @@ /*! \brief Create an image2d from an 2d array of values. * - * \param[in] 2d array. + * \param[in] values 2d array. * * \return A 2D image. */ Index: trunk/milena/mln/make/point1d.hh =================================================================== --- trunk/milena/mln/make/point1d.hh (revision 1476) +++ trunk/milena/mln/make/point1d.hh (revision 1477) @@ -44,8 +44,7 @@ /*! \brief Create an mln::point1d. * - * \param[in] ind Ind coordinate. - * \param[in] col Column coordinate. + * \param[in] ind Index. * * \return A 1D point. */ Index: trunk/milena/mln/win/octagon2d.hh =================================================================== --- trunk/milena/mln/win/octagon2d.hh (revision 1476) +++ trunk/milena/mln/win/octagon2d.hh (revision 1477) @@ -87,7 +87,7 @@ /*! \brief Constructor. * - * \param[in] lenght Length, of the octagon. + * \param[in] length Length, of the octagon. * * \pre \p length is such as length = 6*x + 1 where x >= 0. */ Index: trunk/milena/mln/labeling/regional_minima.hh =================================================================== --- trunk/milena/mln/labeling/regional_minima.hh (revision 1476) +++ trunk/milena/mln/labeling/regional_minima.hh (revision 1477) @@ -50,6 +50,7 @@ * \param[in] input The input image. * \param[in] nbh The neighborhood to consider. * \param[out] output The label image. + * \param[out] nlabels The number of labels. * * \return The number of labels. */ Index: trunk/milena/mln/labeling/estimate.hh =================================================================== --- trunk/milena/mln/labeling/estimate.hh (revision 1476) +++ trunk/milena/mln/labeling/estimate.hh (revision 1477) @@ -47,6 +47,7 @@ * input with value \p val. * * \param[in] input The image. + * \param[in] val value. * \result The estimate value. */ template <typename A, typename I> Index: trunk/milena/mln/labeling/regional_maxima.hh =================================================================== --- trunk/milena/mln/labeling/regional_maxima.hh (revision 1476) +++ trunk/milena/mln/labeling/regional_maxima.hh (revision 1477) @@ -50,6 +50,7 @@ * \param[in] input The input image. * \param[in] nbh The neighborhood to consider. * \param[out] output The label image. + * \param[out] nlabels The number of labeled regions. * * \return The number of labels. */