[Olena-patches] 2398: Misc. documentation fixes in complex-related entities.

* mln/core/site_set/p_complex_piter.hh, * mln/core/site_set/p_faces_piter.hh: Here. --- milena/ChangeLog | 8 ++++++++ milena/mln/core/site_set/p_complex_piter.hh | 7 +++++-- milena/mln/core/site_set/p_faces_piter.hh | 9 +++++++-- 3 files changed, 20 insertions(+), 4 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 6cd837a..aa7dc82 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -41,6 +41,14 @@ 2008-09-24 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Misc. documentation fixes in complex-related entities. + + * mln/core/site_set/p_complex_piter.hh, + * mln/core/site_set/p_faces_piter.hh: + Here. + +2008-09-24 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Get back to the previous, simpler interface of mln::complex_image. * mln/core/image/complex_image.hh diff --git a/milena/mln/core/site_set/p_complex_piter.hh b/milena/mln/core/site_set/p_complex_piter.hh index 41671ce..114eed6 100644 --- a/milena/mln/core/site_set/p_complex_piter.hh +++ b/milena/mln/core/site_set/p_complex_piter.hh @@ -30,6 +30,9 @@ /// \file mln/core/site_set/p_complex_piter.hh /// \brief Definition of point iterator on complex-based pset. +/// +/// Types defined here are akin to parametrized typedefs: the code is +/// factored in mln::internal::p_complex_piter_base_. # include <mln/core/site_set/p_complex.hh> # include <mln/core/internal/p_complex_piter_base.hh> @@ -49,7 +52,7 @@ namespace mln | p_complex_fwd_piter_<D, P>. | `-----------------------------*/ - /// \brief Forward iterator on point sites of a mln::p_complex<D, P>. + /// \brief Forward iterator on (all) the faces of an mln::p_complex<D, P>. template <unsigned D, typename P> class p_complex_fwd_piter_ : public internal::p_complex_piter_base_< complex_fwd_iter_<D>, @@ -76,7 +79,7 @@ namespace mln | p_complex_bkd_piter_<D, P>. | `-----------------------------*/ - /// \brief Backward iterator on point sites of a mln::p_complex<D, P>. + /// \brief Backward iterator on (all) the faces of an mln::p_complex<D, P>. template <unsigned D, typename P> class p_complex_bkd_piter_ : public internal::p_complex_piter_base_< complex_bkd_iter_<D>, diff --git a/milena/mln/core/site_set/p_faces_piter.hh b/milena/mln/core/site_set/p_faces_piter.hh index b26ca9b..65f07fd 100644 --- a/milena/mln/core/site_set/p_faces_piter.hh +++ b/milena/mln/core/site_set/p_faces_piter.hh @@ -30,6 +30,9 @@ /// \file mln/core/site_set/p_faces_piter.hh /// \brief Definition of point iterator on complex-based pset. +/// +/// Types defined here are akin to parametrized typedefs: the code is +/// factored in mln::internal::p_complex_piter_base_. # include <mln/core/site_set/p_faces.hh> # include <mln/core/internal/p_complex_piter_base.hh> @@ -50,7 +53,8 @@ namespace mln | p_faces_fwd_piter_<N, D, P>. | `------------------------------*/ - /// \brief Forward iterator on point sites of a mln::p_faces<N, D, P>. + /// \brief Forward iterator on the \p N-faces sites of an + /// mln::p_faces<N, D, P>. template <unsigned N, unsigned D, typename P> class p_faces_fwd_piter_ : public internal::p_complex_piter_base_< faces_fwd_iter_<N, D>, @@ -77,7 +81,8 @@ namespace mln | p_faces_bkd_piter_<N, D, P>. | `------------------------------*/ - /// \brief Backward iterator on point sites of a mln::p_faces<N, D, P>. + /// \brief Backward iterator on the \p N-faces sites of an + /// mln::p_faces<N, D, P>. template <unsigned N, unsigned D, typename P> class p_faces_bkd_piter_ /* FIXME: Rename internal::p_complex_piter_base_ to something else, -- 1.6.0.1