[Olena-patches] 2300: Update the Doxygen documentation of iterator internal classes.

* mln/core/internal/site_set_iterator_base.hh * mln/core/internal/site_relative_iterator_base.hh: Do it. --- milena/ChangeLog | 8 ++++++++ .../core/internal/site_relative_iterator_base.hh | 7 ++++--- milena/mln/core/internal/site_set_iterator_base.hh | 3 +++ 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 18f27e1..f8750e4 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2008-09-17 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Update the Doxygen documentation of iterator internal classes. + + * mln/core/internal/site_set_iterator_base.hh + * mln/core/internal/site_relative_iterator_base.hh: + Do it. + +2008-09-17 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Update the Doxygen documentation of site set internal classes. * mln/core/internal/site_set_base.hh: Do it. diff --git a/milena/mln/core/internal/site_relative_iterator_base.hh b/milena/mln/core/internal/site_relative_iterator_base.hh index f9b582f..b488ee7 100644 --- a/milena/mln/core/internal/site_relative_iterator_base.hh +++ b/milena/mln/core/internal/site_relative_iterator_base.hh @@ -49,14 +49,15 @@ namespace mln namespace internal { - /*! \brief A generic forward iterator on points of windows and of + /*! \brief A generic iterator on points of windows and of * neighborhoods. * * Parameter \c S is the targeted "site set definition" type. It * can be either a Window, or a Neighborhood. * - * IMPORTANT: Sub-classes have to define do_start_, do_next_, and - * compute_p_. They shall define NEITHER start_ NOR next_. + * IMPORTANT: Sub-classes have to define do_start_, do_next_, + * is_valid_, invalidate_ and compute_p_. They shall define + * NEITHER start_ NOR next_. */ template <typename S, typename E> class site_relative_iterator_base : public site_iterator_base< S, E > diff --git a/milena/mln/core/internal/site_set_iterator_base.hh b/milena/mln/core/internal/site_set_iterator_base.hh index 376e5d6..6b76994 100644 --- a/milena/mln/core/internal/site_set_iterator_base.hh +++ b/milena/mln/core/internal/site_set_iterator_base.hh @@ -46,6 +46,9 @@ namespace mln /*! \internal A base class for site iterators. * * Parameter \c S is the targeted site set type. + * + * IMPORTANT: Sub-classes have to define start_, next_, + * is_valid_ and invalidate_. */ template <typename S, typename E> class site_set_iterator_base : public site_iterator_base<S, E> -- 1.6.0.1