[Olena-patches] olena: olena-2.0-592-g309be63 mln/core/concept/iterator.hh: Document iterator macros.

--- milena/ChangeLog | 4 ++++ milena/mln/core/concept/iterator.hh | 30 ++++++++++++++++++++++-------- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index ef80cbb..35d0b5d 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/concept/iterator.hh: Document iterator macros. + +2013-04-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Move concepts in their related type module. * mln/core/concept/image.hh, diff --git a/milena/mln/core/concept/iterator.hh b/milena/mln/core/concept/iterator.hh index 9de2034..a8f74ec 100644 --- a/milena/mln/core/concept/iterator.hh +++ b/milena/mln/core/concept/iterator.hh @@ -33,14 +33,20 @@ # include <mln/core/concept/object.hh> -/*! \brief Loop to browse all the elements targetted by the iterator - * \p x. +/*! + \def for_all(x) + \brief Loop to browse all the elements targetted by the iterator + \p x. + \ingroup mlnmacros */ # define for_all(x) for(x.start(); x.is_valid(); x.next()) -/*! \brief Loop to browse all the elements targetted by the couples of - * iterators \p x1 and \p x2. +/*! + \def for_all_2(x1, x2) + \brief Loop to browse all the elements targetted by the couples of + iterators \p x1 and \p x2. + \ingroup mlnmacros */ # define for_all_2(x1, x2) \ for(x1.start(), x2.start(); \ @@ -48,8 +54,11 @@ x1.next(), x2.next()) -/*! \brief Loop to browse all the elements targetted by the triplet of - * iterators \p x1, \p x2, and \p x3. +/*! + \def for_all_3(x1, x2, x3) + \brief Loop to browse all the elements targetted by the triplet of + iterators \p x1, \p x2, and \p x3. + \ingroup mlnmacros */ # define for_all_3(x1, x2, x3) \ for(x1.start(), x2.start(), x3.start(); \ @@ -57,8 +66,13 @@ x1.next(), x2.next(), x3.next()) -/*! \brief Loop to browse all the remaining elements targetted by the - * iterator \p x. +/* + \def for_all_remaining(x) + + \brief Loop to browse all the remaining elements targetted by the + iterator \p x. + + \ingroup mlnmacros */ # define for_all_remaining(x) \ if (! x.is_valid()) {} else while (x.next(), x.is_valid()) -- 1.7.2.5