[Olena-patches] olena: olena-2.0-578-g8299246 mln/core/internal/image_base.hh: Add more documentation for destroy() method.

--- milena/ChangeLog | 5 +++++ milena/mln/core/internal/image_base.hh | 9 ++++++++- 2 files changed, 13 insertions(+), 1 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 49afff7..364f90b 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,8 @@ +2013-04-26 Guillaume Lazzara <z(a)lrde.epita.fr> + + * mln/core/internal/image_base.hh: Add more documentation for + destroy() method. + 2013-04-25 Guillaume Lazzara <z(a)lrde.epita.fr> * doc/mln/topo/topo.dox: New. Introduce mathematical topology diff --git a/milena/mln/core/internal/image_base.hh b/milena/mln/core/internal/image_base.hh index 1b068ca..94f727b 100644 --- a/milena/mln/core/internal/image_base.hh +++ b/milena/mln/core/internal/image_base.hh @@ -163,7 +163,14 @@ namespace mln /// \endcond - /// Detach data from an image (free it if nobody else hold it). + /*! + + \brief Detach data from an image (free it if nobody else hold + it). + + This method can be safely called several times. + After calling destroy(), is_valid() always returns False. + */ void destroy(); protected: -- 1.7.2.5