[Olena-patches] olena: olena-2.0-616-g43941b5 Add summaries of common typedefs in concrete images.

* mln/core/image/image1d.hh, * mln/core/image/image2d.hh, * mln/core/image/image3d.hh: Here. --- milena/ChangeLog | 8 ++++++++ milena/mln/core/image/image1d.hh | 36 ++++++++++++++++++++++++++++-------- milena/mln/core/image/image2d.hh | 36 ++++++++++++++++++++++++++++-------- milena/mln/core/image/image3d.hh | 36 ++++++++++++++++++++++++++++-------- 4 files changed, 92 insertions(+), 24 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index a9bfc7e..319a05d 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-05-16 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Add summaries of common typedefs in concrete images. + + * mln/core/image/image1d.hh, + * mln/core/image/image2d.hh, + * mln/core/image/image3d.hh: Here. + +2013-05-16 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Add more "See also" references. * mln/core/alias/box1d.hh, diff --git a/milena/mln/core/image/image1d.hh b/milena/mln/core/image/image1d.hh index b5ed229..b67b084 100644 --- a/milena/mln/core/image/image1d.hh +++ b/milena/mln/core/image/image1d.hh @@ -125,14 +125,34 @@ namespace mln template <typename V> struct image1d; - /// Basic 1D image class. - /// - /// The parameter \c V is the type of pixel values. This image class - /// stores data in memory and has a virtual border with constant - /// thickness before and after data. - /// - /// \ingroup modimageconcrete - // + /*! \brief Basic 1D image class. + + The parameter \c V is the type of pixel values. + + \note This image class stores data in memory and has a virtual + border with constant thickness before and after data. + + <table class="doxtable typedeftable"> + <tr><th>Type name</th><th>Class name</th></tr> + <tr><td>%box</td><td>mln::box1d</td></tr> + <tr><td>%bkd_piter</td><td>box_bkd_piter_&lt; mln::point1d &gt;</td></tr> + <tr><td>%bkd_pixter</td><td>mln::bkd_pixter1d&lt;image1d&lt;V&gt; &gt;</td></tr> + <tr><td>%Compatible neighborhoods</td><td>mln::neighb1d</td></tr> + <tr><td>%Compatible windows</td><td>mln::window1d</td></tr> + <tr><td>%Domain</td><td>mln::box1d</td></tr> + <tr><td>%Dpoint</td><td>mln::dpoint1d</td></tr> + <tr><td>%fwd_piter</td><td>box_fwd_piter_&lt; mln::point1d &gt;</td></tr> + <tr><td>%fwd_pixter</td><td>mln::fwd_pixter1d&lt;image1d&lt;V&gt; &gt;</td></tr> + <tr><td>%Grid</td><td>mln::grid::tick</td></tr> + <tr><td>%Piter</td><td>box_fwd_piter_&lt; mln::point1d &gt;</td></tr> + <tr><td>%Pixter</td><td>mln::fwd_pixter1d&lt;image1d&lt;V&gt; &gt;</td></tr> + <tr><td>%PSite</td><td>mln::point1d</td></tr> + <tr><td>%Site</td><td>mln::point1d</td></tr> + <tr><td>%Value</td><td>V</td></tr> + </table> + + \ingroup modimageconcrete + */ template <typename V> struct image1d : public internal::image_primary< V, box1d, image1d<V> > diff --git a/milena/mln/core/image/image2d.hh b/milena/mln/core/image/image2d.hh index fee7b34..a2d38cb 100644 --- a/milena/mln/core/image/image2d.hh +++ b/milena/mln/core/image/image2d.hh @@ -122,14 +122,34 @@ namespace mln - /// Basic 2D image class. - /// - /// The parameter \c V is the type of pixel values. This image class - /// stores data in memory and has a virtual border with constant - /// thickness around data. - /// - /// \ingroup modimageconcrete - // + /*! \brief Basic 2D image class. + + The parameter \c V is the type of pixel values. + + \note This image class stores data in memory and has a virtual + border with constant thickness around data. + + <table class="doxtable typedeftable"> + <tr><th>Type name</th><th>Class name</th></tr> + <tr><td>%box</td><td>mln::box2d</td></tr> + <tr><td>%bkd_piter</td><td>box_bkd_piter_&lt; mln::point2d &gt;</td></tr> + <tr><td>%bkd_pixter</td><td>mln::bkd_pixter2d&lt;image2d&lt;V&gt; &gt;</td></tr> + <tr><td>%Compatible neighborhoods</td><td>mln::neighb2d</td></tr> + <tr><td>%Compatible windows</td><td>mln::window2d</td></tr> + <tr><td>%Domain</td><td>mln::box2d</td></tr> + <tr><td>%Dpoint</td><td>mln::dpoint2d</td></tr> + <tr><td>%fwd_piter</td><td>box_fwd_piter_&lt; mln::point2d &gt;</td></tr> + <tr><td>%fwd_pixter</td><td>mln::fwd_pixter2d&lt;image2d&lt;V&gt; &gt;</td></tr> + <tr><td>%Grid</td><td>mln::grid::square</td></tr> + <tr><td>%Piter</td><td>box_fwd_piter_&lt; mln::point2d &gt;</td></tr> + <tr><td>%Pixter</td><td>mln::fwd_pixter2d&lt;image2d&lt;V&gt; &gt;</td></tr> + <tr><td>%PSite</td><td>mln::point2d</td></tr> + <tr><td>%Site</td><td>mln::point2d</td></tr> + <tr><td>%Value</td><td>V</td></tr> + </table> + + \ingroup modimageconcrete + */ template <typename V> class image2d : public internal::image_primary< V, mln::box2d, image2d<V> > { diff --git a/milena/mln/core/image/image3d.hh b/milena/mln/core/image/image3d.hh index 22924c3..bb3ad31 100644 --- a/milena/mln/core/image/image3d.hh +++ b/milena/mln/core/image/image3d.hh @@ -121,14 +121,34 @@ namespace mln - /// Basic 3D image class. - /// - /// The parameter \c V is the type of pixel values. This image class - /// stores data in memory and has a virtual border with constant - /// thickness around data. - /// - /// \ingroup modimageconcrete - // + /*! \brief Basic 3D image class. + + The parameter \c V is the type of pixel values. + + \note This image class stores data in memory and has a virtual + border with constant thickness around data. + + <table class="doxtable typedeftable"> + <tr><th>Type name</th><th>Class name</th></tr> + <tr><td>%box</td><td>mln::box3d</td></tr> + <tr><td>%bkd_piter</td><td>box_bkd_piter_&lt; mln::point3d &gt;</td></tr> + <tr><td>%bkd_pixter</td><td>mln::bkd_pixter3d&lt;image3d&lt;V&gt; &gt;</td></tr> + <tr><td>%Compatible neighborhoods</td><td>mln::neighb3d</td></tr> + <tr><td>%Compatible windows</td><td>mln::window3d</td></tr> + <tr><td>%Domain</td><td>mln::box3d</td></tr> + <tr><td>%Dpoint</td><td>mln::dpoint3d</td></tr> + <tr><td>%fwd_piter</td><td>box_fwd_piter_&lt; mln::point3d &gt;</td></tr> + <tr><td>%fwd_pixter</td><td>mln::fwd_pixter3d&lt;image3d&lt;V&gt; &gt;</td></tr> + <tr><td>%Grid</td><td>mln::grid::cube</td></tr> + <tr><td>%Piter</td><td>box_fwd_piter_&lt; mln::point3d &gt;</td></tr> + <tr><td>%Pixter</td><td>mln::fwd_pixter3d&lt;image3d&lt;V&gt; &gt;</td></tr> + <tr><td>%PSite</td><td>mln::point3d</td></tr> + <tr><td>%Site</td><td>mln::point3d</td></tr> + <tr><td>%Value</td><td>V</td></tr> + </table> + + \ingroup modimageconcrete + */ template <typename V> struct image3d : public internal::image_primary< V, box3d, image3d<V> > { -- 1.7.2.5