[Olena-patches] olena-2.0-102-g1e63053 mln/core/internal/image_base.hh: Improve documentation.

--- milena/ChangeLog | 4 +++ milena/mln/core/internal/image_base.hh | 33 ++++++++++++++++++------------- 2 files changed, 23 insertions(+), 14 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 5ad6a19..67cf83a 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2012-08-23 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + * mln/core/internal/image_base.hh: Improve documentation. + +2012-08-23 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + * mln/data/compute_in_window.hh: Fix warnings. 2012-05-10 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; diff --git a/milena/mln/core/internal/image_base.hh b/milena/mln/core/internal/image_base.hh index f1ba4f9..6b60121 100644 --- a/milena/mln/core/internal/image_base.hh +++ b/milena/mln/core/internal/image_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -43,18 +43,6 @@ # include <mln/value/set.hh> # include <mln/value/super_value.hh> -// image_base -// ^ -// | -// --------------------------- -// | | -// image_primary image_morpher -// ^ ^ -// | | -// | ----------------------------------------- -// | | | | -// pw_image_base image_domain_morpher image_value_morpher image_identity - namespace mln { @@ -73,10 +61,27 @@ namespace mln - /// A base class for images. + /// \brief A base class for images. /// /// Parameter \p T is the image value type. /// Parameter \p S is the image site set type. + /// + /// \internal + /// + /// \verbatim + /// image_base + /// ^ + /// | + /// --------------------------- + /// | | + /// image_primary image_morpher + /// ^ ^ + /// | | + /// | ----------------------------------------- + /// | | | | + /// pw_image_base image_domain_morpher image_value_morpher image_identity + /// + /// \endverbatim // template <typename T, typename S, typename E> struct image_base -- 1.7.2.5