[Olena-patches] olena: olena-2.0-602-g81f1b95 mln/core/routine/duplicate.hh: Document this routine.

--- milena/ChangeLog | 4 ++++ milena/mln/core/routine/duplicate.hh | 24 ++++++++++++++++-------- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index d5b38b1..039f880 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2013-04-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + * mln/core/routine/duplicate.hh: Document this routine. + +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(). diff --git a/milena/mln/core/routine/duplicate.hh b/milena/mln/core/routine/duplicate.hh index fb79569..fe814c5 100644 --- a/milena/mln/core/routine/duplicate.hh +++ b/milena/mln/core/routine/duplicate.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -38,13 +39,20 @@ namespace mln { - /// Duplicate the image \p model with the values of the image \p - /// data. - /// - /// \param[in] model The image to be duplicated. - /// \result The duplicate. - /// - /// \pre model.is_valid + /*! + \brief Duplicate the image \p model with the values of the image + \p data. + + \param[in] model The image to be duplicated. + \result The duplicate. + + This routine performs a deep copy (create new data) of an image. + It can be used to copy an image or to create a concrete image + (\ref modimageconcrete) from a morphed image (\ref + modimagemorpher). + + \pre model.is_valid + */ template <typename I> mln_concrete(I) duplicate(const Image<I>& model); -- 1.7.2.5