[Olena-patches] olena: olena-2.0-615-g8e83344 Add more "See also" references.

* mln/core/alias/box1d.hh, * mln/core/alias/box2d.hh, * mln/core/alias/box3d.hh, * mln/core/alias/point1d.hh, * mln/core/alias/point2d.hh, * mln/core/alias/point3d.hh, * mln/core/grids.hh, * mln/core/pixter1d.hh, * mln/core/pixter2d.hh, * mln/core/pixter3d.hh, * mln/core/site_set/box_piter.hh: Here. --- milena/ChangeLog | 16 ++++++++++++++++ milena/mln/core/alias/box1d.hh | 2 +- milena/mln/core/alias/box2d.hh | 2 +- milena/mln/core/alias/box3d.hh | 2 +- milena/mln/core/alias/point1d.hh | 4 ++++ milena/mln/core/alias/point2d.hh | 4 ++++ milena/mln/core/alias/point3d.hh | 4 ++++ milena/mln/core/grids.hh | 14 +++++++++++++- milena/mln/core/pixter1d.hh | 2 ++ milena/mln/core/pixter2d.hh | 4 ++-- milena/mln/core/pixter3d.hh | 2 ++ milena/mln/core/site_set/box_piter.hh | 4 ++-- 12 files changed, 52 insertions(+), 8 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index f14e23c..a9bfc7e 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,19 @@ +2013-05-16 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + + Add more "See also" references. + + * mln/core/alias/box1d.hh, + * mln/core/alias/box2d.hh, + * mln/core/alias/box3d.hh, + * mln/core/alias/point1d.hh, + * mln/core/alias/point2d.hh, + * mln/core/alias/point3d.hh, + * mln/core/grids.hh, + * mln/core/pixter1d.hh, + * mln/core/pixter2d.hh, + * mln/core/pixter3d.hh, + * mln/core/site_set/box_piter.hh: Here. + 2013-05-15 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; Be more precise about relationship between sites and iterators. diff --git a/milena/mln/core/alias/box1d.hh b/milena/mln/core/alias/box1d.hh index df7398f..35003b0 100644 --- a/milena/mln/core/alias/box1d.hh +++ b/milena/mln/core/alias/box1d.hh @@ -68,7 +68,7 @@ namespace mln -----X--------X---------X--------> \endverbatim - \sa mln::make::box1d. + \sa mln::make::box1d mln::image1d mln::point1d \ingroup modsitesetbasic */ diff --git a/milena/mln/core/alias/box2d.hh b/milena/mln/core/alias/box2d.hh index 8aa7e3b..13d4399 100644 --- a/milena/mln/core/alias/box2d.hh +++ b/milena/mln/core/alias/box2d.hh @@ -75,7 +75,7 @@ namespace mln v \endverbatim - \sa mln::make::box2d. + \sa mln::make::box2d mln::image2d mln::point2d \ingroup modsitesetbasic */ diff --git a/milena/mln/core/alias/box3d.hh b/milena/mln/core/alias/box3d.hh index 020f85b..a7d11d5 100644 --- a/milena/mln/core/alias/box3d.hh +++ b/milena/mln/core/alias/box3d.hh @@ -78,7 +78,7 @@ namespace mln \endverbatim - \sa mln::make::box3d. + \sa mln::make::box3d mln::image3d mln::point3d \ingroup modsitesetbasic */ diff --git a/milena/mln/core/alias/point1d.hh b/milena/mln/core/alias/point1d.hh index a989116..462ddd2 100644 --- a/milena/mln/core/alias/point1d.hh +++ b/milena/mln/core/alias/point1d.hh @@ -49,6 +49,8 @@ namespace mln \brief Point defined on the 1D ruler grid with integer coordinates. + + \see mln::image1d mln::box1d */ /// \cond ALIAS typedef point<grid::tick, def::coord> point1d; @@ -60,6 +62,8 @@ namespace mln \brief Point defined on the 1D ruler grid with floating-point coordinates. + + \see mln::image1d mln::box1d */ /// \cond ALIAS typedef point<grid::tick, def::coordf> point1df; diff --git a/milena/mln/core/alias/point2d.hh b/milena/mln/core/alias/point2d.hh index 04db631..901f68b 100644 --- a/milena/mln/core/alias/point2d.hh +++ b/milena/mln/core/alias/point2d.hh @@ -49,6 +49,8 @@ namespace mln \brief Point defined on the 2D square grid with integer coordinates. + + \see mln::image2d mln::box2d */ /// \cond ALIAS typedef point<mln::grid::square, mln::def::coord> point2d; @@ -61,6 +63,8 @@ namespace mln \brief Point defined on the 2D square grid with floating-point coordinates. + + \see mln::image2d mln::box2d */ /// \cond ALIAS typedef point<mln::grid::square, mln::def::coordf> point2df; diff --git a/milena/mln/core/alias/point3d.hh b/milena/mln/core/alias/point3d.hh index a82df39..2686ae0 100644 --- a/milena/mln/core/alias/point3d.hh +++ b/milena/mln/core/alias/point3d.hh @@ -48,6 +48,8 @@ namespace mln \brief Point defined on the 3D square grid with integer coordinates. + + \see mln::image3d mln::box3d */ /// \cond ALIAS typedef point<grid::cube, def::coord> point3d; @@ -60,6 +62,8 @@ namespace mln \brief Point defined on the 3D square grid with floating-point coordinates. + + \see mln::image3d mln::box3d */ /// \cond ALIAS typedef point<grid::cube, def::coordf> point3df; diff --git a/milena/mln/core/grids.hh b/milena/mln/core/grids.hh index b215d1c..5949323 100644 --- a/milena/mln/core/grids.hh +++ b/milena/mln/core/grids.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -42,24 +43,35 @@ namespace mln namespace grid { + /*! \brief Regular 1D grid (line). + \see mln::image1d + */ struct tick : public Regular_Grid< tick > { typedef metal::true_ aligned; enum { dim = 1 }; }; + /*! \brief Regular square 2D grid (square). + \see mln::image2d + */ struct square : public Regular_Grid< square > { typedef metal::true_ aligned; enum { dim = 2 }; }; + /*! \brief Regular hexagonal 2D grid (square). + */ struct hexa : public Regular_Grid< hexa > { typedef metal::false_ aligned; enum { dim = 2 }; }; + /*! \brief Regular 3D grid (cube). + \see mln::image3d + */ struct cube : public Regular_Grid< cube > { typedef metal::true_ aligned; diff --git a/milena/mln/core/pixter1d.hh b/milena/mln/core/pixter1d.hh index 8c76129..27080f9 100644 --- a/milena/mln/core/pixter1d.hh +++ b/milena/mln/core/pixter1d.hh @@ -43,6 +43,7 @@ namespace mln /*! \brief Forward pixel iterator on a 1-D image with border. + \see mln::image1d */ template <typename I> class fwd_pixter1d : @@ -71,6 +72,7 @@ namespace mln /*! \brief Backward pixel iterator on a 1-D image with border. + \see mln::image1d */ template <typename I> class bkd_pixter1d : diff --git a/milena/mln/core/pixter2d.hh b/milena/mln/core/pixter2d.hh index 2837543..c753f5f 100644 --- a/milena/mln/core/pixter2d.hh +++ b/milena/mln/core/pixter2d.hh @@ -44,8 +44,8 @@ namespace mln `------------------*/ /*! - \internal \brief Forward pixel iterator on a 2-D image with border. + \see mln::image2d */ template <typename I> class fwd_pixter2d @@ -91,8 +91,8 @@ namespace mln `------------------*/ /*! - \internal \brief Backward pixel iterator on a 2-D image with border. + \see mln::image2d */ template <typename I> class bkd_pixter2d diff --git a/milena/mln/core/pixter3d.hh b/milena/mln/core/pixter3d.hh index 31d115c..b12a068 100644 --- a/milena/mln/core/pixter3d.hh +++ b/milena/mln/core/pixter3d.hh @@ -46,6 +46,7 @@ namespace mln /*! \brief Forward pixel iterator on a 3-D image with border. + \see mln::image3d */ template <typename I> class fwd_pixter3d @@ -102,6 +103,7 @@ namespace mln /*! \brief Backward pixel iterator on a 3-D image with border. + \see mln::image3d */ template <typename I> class bkd_pixter3d diff --git a/milena/mln/core/site_set/box_piter.hh b/milena/mln/core/site_set/box_piter.hh index 0d32567..744e3a9 100644 --- a/milena/mln/core/site_set/box_piter.hh +++ b/milena/mln/core/site_set/box_piter.hh @@ -44,7 +44,7 @@ namespace mln The parameter \c P is the type of points. - \see mln::box + \see mln::box mln::image1d mln::image2d mln::image3d */ template <typename P> class box_fwd_piter_ : public internal::site_set_iterator_base< box<P>, @@ -93,7 +93,7 @@ namespace mln The parameter \c P is the type of points. - \see mln::box + \see mln::box mln::image1d mln::image2d mln::image3d */ template <typename P> class box_bkd_piter_ : public internal::site_set_iterator_base< box<P>, -- 1.7.2.5