[Olena-patches] milena r1623: Clean internal namespace in core

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena ChangeLog: 2007-12-21 Guillaume Duhamel &lt;guillaume.duhamel(a)lrde.epita.fr&gt; Clean internal namespace in core. * mln/core/a_point_of.hh, * mln/core/cast_image.hh, * mln/core/clone.hh, * mln/core/decorated_image.hh, * mln/core/dpoint.hh, * mln/core/dpoint1d.hh, * mln/core/dpoint2d.hh, * mln/core/dpoint3d.hh, * mln/core/dpoints_piter.hh, * mln/core/dpoints_pixter.hh, * mln/core/exact.hh, * mln/core/fi_adaptor.hh, * mln/core/hexa.hh, * mln/core/image2d.hh, * mln/core/image3d.hh, * mln/core/image_if.hh, * mln/core/image_if_interval.hh, * mln/core/image_if_value.hh, * mln/core/interpolated.hh, * mln/core/mesh_image.hh, * mln/core/mesh_p.hh, * mln/core/mono_obased_rle_image.hh, * mln/core/mono_rle_image.hh, * mln/core/obased_rle_image.hh, * mln/core/plain.hh, * mln/core/rle_image.hh, * mln/core/safe.hh, * mln/core/sparse_image.hh, * mln/core/sub_image.hh, * mln/core/t_image.hh, * mln/core/tr_image.hh, * mln/core/translate_image.hh: Clean and fix in internal namespace Doxygen comments. --- a_point_of.hh | 4 +++- cast_image.hh | 5 +++-- clone.hh | 3 ++- decorated_image.hh | 10 ++++++---- dpoint.hh | 2 +- dpoint1d.hh | 9 ++++++++- dpoint2d.hh | 9 ++++++++- dpoint3d.hh | 9 ++++++++- fi_adaptor.hh | 2 +- hexa.hh | 2 +- image2d.hh | 2 +- image3d.hh | 2 +- image_if.hh | 3 +-- image_if_interval.hh | 2 +- image_if_value.hh | 4 +--- interpolated.hh | 1 + mesh_image.hh | 1 + mesh_p.hh | 2 +- mono_obased_rle_image.hh | 1 + mono_rle_image.hh | 1 + obased_rle_image.hh | 1 + plain.hh | 1 + rle_image.hh | 1 + safe.hh | 1 + sparse_image.hh | 1 + sub_image.hh | 1 + t_image.hh | 2 +- tr_image.hh | 1 + translate_image.hh | 1 + 29 files changed, 60 insertions(+), 24 deletions(-) Index: trunk/milena/mln/core/dpoint1d.hh =================================================================== --- trunk/milena/mln/core/dpoint1d.hh (revision 1622) +++ trunk/milena/mln/core/dpoint1d.hh (revision 1623) @@ -56,13 +56,20 @@ namespace mln { - // FIXME: Doc! + /*! + * \brief Definition of a shortcut for delta point in 1d. + * \{ + */ + const dpoint1d before = make::dpoint1d( -1 ); const dpoint1d after = make::dpoint1d( +1 ); const dpoint1d ind_dec = before; const dpoint1d ind_inc = after; + /*! \} + */ + } // end of namespace mln Index: trunk/milena/mln/core/dpoint2d.hh =================================================================== --- trunk/milena/mln/core/dpoint2d.hh (revision 1622) +++ trunk/milena/mln/core/dpoint2d.hh (revision 1623) @@ -56,12 +56,19 @@ namespace mln { - // FIXME: Doc! + /*! + * \brief Definition of a shortcut for delta point in 2d. + * \{ + */ const dpoint2d up = make::dpoint2d( -1, 0 ); const dpoint2d down = make::dpoint2d( +1, 0 ); const dpoint2d left = make::dpoint2d( 0, -1 ); const dpoint2d right = make::dpoint2d( 0, +1 ); + /*! + * \} + */ + } // end of namespace mln Index: trunk/milena/mln/core/dpoints_piter.hh =================================================================== Index: trunk/milena/mln/core/dpoint3d.hh =================================================================== --- trunk/milena/mln/core/dpoint3d.hh (revision 1622) +++ trunk/milena/mln/core/dpoint3d.hh (revision 1623) @@ -56,7 +56,10 @@ namespace mln { - // FIXME: Doc! + /*! + * \brief Definition of a shortcut for delta point in 3d. + * \{ + */ const dpoint3d sagittal_dec = make::dpoint3d( 0, 0, -1); const dpoint3d sagittal_inc = make::dpoint3d( 0, 0, +1); const dpoint3d axial_dec = make::dpoint3d( 0, -1, 0); @@ -64,6 +67,10 @@ const dpoint3d coronal_dec = make::dpoint3d(-1, 0, 0); const dpoint3d coronal_inc = make::dpoint3d(+1, 0, 0); + /*! + * \} + */ + } // end of namespace mln Index: trunk/milena/mln/core/decorated_image.hh =================================================================== --- trunk/milena/mln/core/decorated_image.hh (revision 1622) +++ trunk/milena/mln/core/decorated_image.hh (revision 1623) @@ -62,7 +62,7 @@ typedef mln::value::proxy<const E> lvalue; }; - /// \internal + /// \internal Data structure for \c mln::decorated_image<I,D>. template <typename I, typename D> struct data_< decorated_image<I,D> > { @@ -76,8 +76,10 @@ - // FIXME: Doc! - + /*! + * \brief Class of decorated image : FIXME Doc + * + */ template <typename I, typename D> struct decorated_image : public internal::decorated_image_impl_< I, decorated_image<I,D> >, @@ -133,7 +135,7 @@ namespace internal { - // \internal internal::data_< decorated_image<I,S> > + /// \internal internal::data_< decorated_image<I,S> > template <typename I, typename D> inline data_< decorated_image<I,D> >::data_(I& ima, const D& deco) Index: trunk/milena/mln/core/translate_image.hh =================================================================== --- trunk/milena/mln/core/translate_image.hh (revision 1622) +++ trunk/milena/mln/core/translate_image.hh (revision 1623) @@ -49,6 +49,7 @@ namespace internal { + /// \internal Data structure for \c mln::translate_image<I>. template <typename I> struct data_< translate_image<I> > { Index: trunk/milena/mln/core/image_if.hh =================================================================== --- trunk/milena/mln/core/image_if.hh (revision 1622) +++ trunk/milena/mln/core/image_if.hh (revision 1623) @@ -49,11 +49,10 @@ template <typename I, typename F> struct image_if; - /// \internal internal::data_. - namespace internal { + /// \internal Data structure for \c mln::image_if<I,F>. template <typename I, typename F> struct data_< image_if<I,F> > : data_< Super > { Index: trunk/milena/mln/core/exact.hh =================================================================== Index: trunk/milena/mln/core/mesh_p.hh =================================================================== --- trunk/milena/mln/core/mesh_p.hh (revision 1622) +++ trunk/milena/mln/core/mesh_p.hh (revision 1623) @@ -49,7 +49,7 @@ template<typename P> class mesh_p_piter_; template<typename P> - struct mesh_p : public internal::point_set_base_< P, mesh_p<P> > + struct mesh_p : public internal::point_set_base_< mesh_psite<P>, mesh_p<P> > { typedef util::graph<void> graph; Index: trunk/milena/mln/core/dpoints_pixter.hh =================================================================== Index: trunk/milena/mln/core/rle_image.hh =================================================================== --- trunk/milena/mln/core/rle_image.hh (revision 1622) +++ trunk/milena/mln/core/rle_image.hh (revision 1623) @@ -49,6 +49,7 @@ namespace internal { + /// \internal Data structure for \c mln::rle_image<P,T>. template <typename P, typename T> struct data_< rle_image<P,T> > { Index: trunk/milena/mln/core/hexa.hh =================================================================== --- trunk/milena/mln/core/hexa.hh (revision 1622) +++ trunk/milena/mln/core/hexa.hh (revision 1623) @@ -50,7 +50,7 @@ namespace internal { - + /// \internal Data structure for \c mln::hexa<I>. template <typename I> struct data_< hexa<I> > { Index: trunk/milena/mln/core/tr_image.hh =================================================================== --- trunk/milena/mln/core/tr_image.hh (revision 1622) +++ trunk/milena/mln/core/tr_image.hh (revision 1623) @@ -51,6 +51,7 @@ namespace internal { + /// \internal Data structure for \c mln::tr_image<T,I>. template <typename T, typename I> struct data_< tr_image<T,I> > { Index: trunk/milena/mln/core/interpolated.hh =================================================================== --- trunk/milena/mln/core/interpolated.hh (revision 1622) +++ trunk/milena/mln/core/interpolated.hh (revision 1623) @@ -49,6 +49,7 @@ namespace internal { + /// \internal Data structure for \c mln::interpolated<I>. template <typename I> struct data_< interpolated<I> > { Index: trunk/milena/mln/core/image_if_value.hh =================================================================== --- trunk/milena/mln/core/image_if_value.hh (revision 1622) +++ trunk/milena/mln/core/image_if_value.hh (revision 1623) @@ -49,11 +49,9 @@ template <typename I> struct image_if_value; - /// \internal internal::data_. - namespace internal { - + /// \internal Data structure for \c mln::image_if_value<I>. template <typename I> struct data_< image_if_value<I> > : data_< Super > { Index: trunk/milena/mln/core/image_if_interval.hh =================================================================== --- trunk/milena/mln/core/image_if_interval.hh (revision 1622) +++ trunk/milena/mln/core/image_if_interval.hh (revision 1623) @@ -57,10 +57,10 @@ template <typename I> struct image_if_interval; - /// \internal internal::data_. namespace internal { + /// \internal Data structure for \c mln::image_if_interval<I>. template <typename I> struct data_< image_if_interval<I> > : data_< Super > { Index: trunk/milena/mln/core/mono_rle_image.hh =================================================================== --- trunk/milena/mln/core/mono_rle_image.hh (revision 1622) +++ trunk/milena/mln/core/mono_rle_image.hh (revision 1623) @@ -49,6 +49,7 @@ namespace internal { + /// \internal Data structure for \c mln::mono_rle_image<P,T>. template <typename P, typename T> struct data_< mono_rle_image<P,T> > { Index: trunk/milena/mln/core/cast_image.hh =================================================================== --- trunk/milena/mln/core/cast_image.hh (revision 1622) +++ trunk/milena/mln/core/cast_image.hh (revision 1623) @@ -50,7 +50,7 @@ namespace internal { - /// \internal + /// \internal Data structure for \c mln::cast_image_<T,I>. template <typename T, typename I> struct data_< cast_image_<T,I> > { @@ -75,7 +75,8 @@ - /*! \brief FIXME + /*! \brief Class of image morpher which takes an image to change its + * data type. * */ template <typename T, typename I> Index: trunk/milena/mln/core/mesh_image.hh =================================================================== --- trunk/milena/mln/core/mesh_image.hh (revision 1622) +++ trunk/milena/mln/core/mesh_image.hh (revision 1623) @@ -51,6 +51,7 @@ namespace internal { + /// \internal Data structure for \c mln::mesh_image<P,V>. template <typename P, typename V> struct data_< mesh_image<P, V> > { Index: trunk/milena/mln/core/obased_rle_image.hh =================================================================== --- trunk/milena/mln/core/obased_rle_image.hh (revision 1622) +++ trunk/milena/mln/core/obased_rle_image.hh (revision 1623) @@ -50,6 +50,7 @@ namespace internal { + /// \internal Data structure for \c mln::obased_rle_image<P,T>. template <typename P, typename T> struct data_< obased_rle_image<P,T> > { Index: trunk/milena/mln/core/safe.hh =================================================================== --- trunk/milena/mln/core/safe.hh (revision 1622) +++ trunk/milena/mln/core/safe.hh (revision 1623) @@ -50,6 +50,7 @@ namespace internal { + /// \internal Data structure for \c mln::safe_image<I>. template <typename I> struct data_< safe_image<I> > { Index: trunk/milena/mln/core/mono_obased_rle_image.hh =================================================================== --- trunk/milena/mln/core/mono_obased_rle_image.hh (revision 1622) +++ trunk/milena/mln/core/mono_obased_rle_image.hh (revision 1623) @@ -51,6 +51,7 @@ namespace internal { + /// \internal Data structure for \c mln::mono_obased_rle_image<P,T>. template <typename P, typename T> struct data_< mono_obased_rle_image<P,T> > { Index: trunk/milena/mln/core/sub_image.hh =================================================================== --- trunk/milena/mln/core/sub_image.hh (revision 1622) +++ trunk/milena/mln/core/sub_image.hh (revision 1623) @@ -50,6 +50,7 @@ namespace internal { + /// \internal Data structure for \c mln::sub_image<I,S>. template <typename I, typename S> struct data_< sub_image<I,S> > { Index: trunk/milena/mln/core/dpoint.hh =================================================================== --- trunk/milena/mln/core/dpoint.hh (revision 1622) +++ trunk/milena/mln/core/dpoint.hh (revision 1623) @@ -54,7 +54,7 @@ /*! \brief Generic delta-point class. * - * Parameters are \c n the dimension of the space and \c C the + * Parameters are \c M the dimension of the space and \c C the * coordinate type in this space. */ template <typename M, typename C> Index: trunk/milena/mln/core/sparse_image.hh =================================================================== --- trunk/milena/mln/core/sparse_image.hh (revision 1622) +++ trunk/milena/mln/core/sparse_image.hh (revision 1623) @@ -49,6 +49,7 @@ namespace internal { + /// \internal Data structure for \c mln::sparse_image<P,T>. template <typename P, typename T> struct data_< sparse_image<P,T> > { Index: trunk/milena/mln/core/clone.hh =================================================================== --- trunk/milena/mln/core/clone.hh (revision 1622) +++ trunk/milena/mln/core/clone.hh (revision 1623) @@ -41,7 +41,8 @@ namespace mln { - /*! Clone the image \p ima with the values of the image \p data. + /*! \brief Clone the image \p ima with the values of the image \p + * data. * * \param[in] ima The image to be cloneed. * \result The clone. Index: trunk/milena/mln/core/plain.hh =================================================================== --- trunk/milena/mln/core/plain.hh (revision 1622) +++ trunk/milena/mln/core/plain.hh (revision 1623) @@ -51,6 +51,7 @@ namespace internal { + /// \internal Data structure for \c mln::plain<I>. template <typename I> struct data_< plain<I> > { Index: trunk/milena/mln/core/t_image.hh =================================================================== --- trunk/milena/mln/core/t_image.hh (revision 1622) +++ trunk/milena/mln/core/t_image.hh (revision 1623) @@ -46,7 +46,7 @@ namespace internal { - /// \internal Data held by a mln::t_image. + /// \internal Data structure for \c mln::t_image<I>. template <typename I> struct data_< t_image<I> > { Index: trunk/milena/mln/core/image2d.hh =================================================================== --- trunk/milena/mln/core/image2d.hh (revision 1622) +++ trunk/milena/mln/core/image2d.hh (revision 1623) @@ -59,7 +59,7 @@ namespace internal { - /// \internal + /// \internal Data structure for \c mln::image2d<T>. template <typename T> struct data_< image2d<T> > { Index: trunk/milena/mln/core/fi_adaptor.hh =================================================================== --- trunk/milena/mln/core/fi_adaptor.hh (revision 1622) +++ trunk/milena/mln/core/fi_adaptor.hh (revision 1623) @@ -61,7 +61,7 @@ namespace internal { - /// \internal + /// \internal Data structure for \c mln::fi_adaptor<I>. template <typename I> struct data_< fi_adaptor<I> > { Index: trunk/milena/mln/core/image3d.hh =================================================================== --- trunk/milena/mln/core/image3d.hh (revision 1622) +++ trunk/milena/mln/core/image3d.hh (revision 1623) @@ -60,7 +60,7 @@ namespace internal { - /// \internal + /// \internal Data structure for \c mln::image3d<T>. template <typename T> struct data_< image3d<T> > { Index: trunk/milena/mln/core/a_point_of.hh =================================================================== --- trunk/milena/mln/core/a_point_of.hh (revision 1622) +++ trunk/milena/mln/core/a_point_of.hh (revision 1623) @@ -39,7 +39,9 @@ namespace mln { - /// Give a point of an image. + /*! + * \brief Give a point of an image. + */ template <typename I> mln_point(I) a_point_of(const Image<I>& ima);