[Olena-patches] milena r1339: Augment doc

URL: https://svn.lrde.org/svn/oln/trunk/milena ChangeLog: 2007-10-16 Simon Nivault &lt;simon.nivault(a)lrde.epita.fr&gt; Augment doc. * mln/convert/to_rgb.hh, * mln/core/cast_image.hh, * mln/core/decorated_image.hh, * mln/core/dpoints_piter.hh, * mln/core/dpoints_pixter.hh, * mln/core/grids.hh, * mln/core/h_mat.hh, * mln/core/h_vec.hh, * mln/core/hexa.hh, * mln/core/hexa_piter.hh, * mln/core/image2d_h.hh, * mln/core/image_if.hh, * mln/core/image_if_interval.hh, * mln/core/image_if_value.hh, * mln/core/init.hh, * mln/core/inplace.hh, * mln/core/interpolated.hh, * mln/core/mesh_image.hh, * mln/core/mesh_p.hh, * mln/core/mesh_p_piter.hh, * mln/core/mesh_psite.hh, * mln/core/plain.hh: Augment. --- convert/to_rgb.hh | 2 +- core/cast_image.hh | 3 ++- core/decorated_image.hh | 4 ++++ core/dpoints_piter.hh | 3 ++- core/dpoints_pixter.hh | 4 ++-- core/grids.hh | 2 +- core/h_mat.hh | 3 +-- core/h_vec.hh | 3 +-- core/hexa.hh | 3 ++- core/hexa_piter.hh | 2 +- core/image2d_h.hh | 5 +++-- core/image_if.hh | 3 ++- core/image_if_interval.hh | 3 ++- core/image_if_value.hh | 3 ++- core/init.hh | 3 ++- core/inplace.hh | 4 +++- core/interpolated.hh | 3 ++- core/mesh_image.hh | 2 +- core/mesh_p.hh | 2 +- core/mesh_p_piter.hh | 2 +- core/mesh_psite.hh | 2 +- core/plain.hh | 3 ++- 22 files changed, 39 insertions(+), 25 deletions(-) Index: trunk/milena/mln/core/dpoints_piter.hh =================================================================== --- trunk/milena/mln/core/dpoints_piter.hh (revision 1338) +++ trunk/milena/mln/core/dpoints_piter.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/dpoints_piter.hh * - * \brief Definition of mln::dpoints_fwd_piter and mln::dpoints_bkd_piter. + * \brief Definition of forward and backward mln::dpoint_ based + * iterators. */ # include <mln/core/internal/point_iterator_base.hh> Index: trunk/milena/mln/core/decorated_image.hh =================================================================== --- trunk/milena/mln/core/decorated_image.hh (revision 1338) +++ trunk/milena/mln/core/decorated_image.hh (revision 1339) @@ -32,6 +32,10 @@ # include <mln/value/proxy.hh> +/*! \file mln/core/decorated_image.hh + * + * \brief Definition of an image that can have additional features. + */ namespace mln { Index: trunk/milena/mln/core/mesh_psite.hh =================================================================== --- trunk/milena/mln/core/mesh_psite.hh (revision 1338) +++ trunk/milena/mln/core/mesh_psite.hh (revision 1339) @@ -30,7 +30,7 @@ /*! \file mln/core/mesh_p.hh * - * \brief Definition of mln::mesh_psite. + * \brief Definition of a graph-based point site. */ namespace mln Index: trunk/milena/mln/core/image_if.hh =================================================================== --- trunk/milena/mln/core/image_if.hh (revision 1338) +++ trunk/milena/mln/core/image_if.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/image_if.hh * - * \brief Definition of a image_if image. + * \brief Definition of a image which domain is restricted by a + * function. */ # include <mln/core/internal/image_if_base.hh> Index: trunk/milena/mln/core/mesh_p.hh =================================================================== --- trunk/milena/mln/core/mesh_p.hh (revision 1338) +++ trunk/milena/mln/core/mesh_p.hh (revision 1339) @@ -37,7 +37,7 @@ /*! \file mln/core/mesh_p.hh * - * \brief Definition of mln::mesh_p. + * \brief Definition of an point set based on graph. */ namespace mln Index: trunk/milena/mln/core/dpoints_pixter.hh =================================================================== --- trunk/milena/mln/core/dpoints_pixter.hh (revision 1338) +++ trunk/milena/mln/core/dpoints_pixter.hh (revision 1339) @@ -30,8 +30,8 @@ /*! \file mln/core/dpoints_pixter.hh * - * \brief Definition of mln::dpoints_fwd_pixter and - * mln::dpoints_bkd_pixter. + * \brief Definition of forward and backward mln::dpoint_ based + * iterators for pixels iterations. */ # include <cassert> Index: trunk/milena/mln/core/mesh_p_piter.hh =================================================================== --- trunk/milena/mln/core/mesh_p_piter.hh (revision 1338) +++ trunk/milena/mln/core/mesh_p_piter.hh (revision 1339) @@ -33,7 +33,7 @@ /*! \file mln/core/mesh_psite.hh * - * \brief Definition of a graph. + * \brief Definition of point iterator on graph-based point set. */ namespace mln Index: trunk/milena/mln/core/h_vec.hh =================================================================== --- trunk/milena/mln/core/h_vec.hh (revision 1338) +++ trunk/milena/mln/core/h_vec.hh (revision 1339) @@ -30,8 +30,7 @@ /*! \file mln/core/h_vec.hh * - * \brief Definition of the mln::h_vec alias and of its - * construction routine. + * \brief Definition of a vector with homogeneous coordinates. */ # include <mln/metal/vec.hh> Index: trunk/milena/mln/core/hexa.hh =================================================================== --- trunk/milena/mln/core/hexa.hh (revision 1338) +++ trunk/milena/mln/core/hexa.hh (revision 1339) @@ -32,7 +32,8 @@ /*! \file mln/core/hexa.hh * - * \brief Definition of the mln::hexa class. + * \brief Definition of a morpher that makes hexagonal the mesh of an + * image. */ # include <mln/core/internal/image_domain_morpher.hh> Index: trunk/milena/mln/core/hexa_piter.hh =================================================================== --- trunk/milena/mln/core/hexa_piter.hh (revision 1338) +++ trunk/milena/mln/core/hexa_piter.hh (revision 1339) @@ -30,7 +30,7 @@ /*! \file mln/core/hexa_piter.hh * - * \brief Definition of iterators on points of pset_ifes. + * \brief Definition of iterators on hexagonal points. */ # include <mln/core/internal/piter_adaptor.hh> Index: trunk/milena/mln/core/interpolated.hh =================================================================== --- trunk/milena/mln/core/interpolated.hh (revision 1338) +++ trunk/milena/mln/core/interpolated.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/interpolated.hh * - * \brief Definition of an image class FIXME + * \brief Definition of a morpher that makes an image become readable + * with floating coordinates. */ # include <cmath> Index: trunk/milena/mln/core/image_if_value.hh =================================================================== --- trunk/milena/mln/core/image_if_value.hh (revision 1338) +++ trunk/milena/mln/core/image_if_value.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/image_if_value.hh * - * \brief Definition of a image_if_value image. + * \brief Definition of a image which domain is restricted by a + * single value. */ # include <mln/core/internal/image_if_base.hh> Index: trunk/milena/mln/core/init.hh =================================================================== --- trunk/milena/mln/core/init.hh (revision 1338) +++ trunk/milena/mln/core/init.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/init.hh * - * \brief Initialization of an image from another one. + * \brief Definition of function that initialize an image from another + * one. */ # include <mln/tag/init.hh> Index: trunk/milena/mln/core/image_if_interval.hh =================================================================== --- trunk/milena/mln/core/image_if_interval.hh (revision 1338) +++ trunk/milena/mln/core/image_if_interval.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/image_if_interval.hh * - * \brief Definition of a image_if_interval image. + * \brief Definition of a image which domain is restricted by a + * interval. */ # include <mln/core/internal/image_if_base.hh> Index: trunk/milena/mln/core/cast_image.hh =================================================================== --- trunk/milena/mln/core/cast_image.hh (revision 1338) +++ trunk/milena/mln/core/cast_image.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/cast_image.hh * - * \brief Definition of an image class FIXME + * \brief Definition of an image morpher that make the user see the + * same image but with another data type. * * \todo Rename as cast_image (without '_')! */ Index: trunk/milena/mln/core/mesh_image.hh =================================================================== --- trunk/milena/mln/core/mesh_image.hh (revision 1338) +++ trunk/milena/mln/core/mesh_image.hh (revision 1339) @@ -30,7 +30,7 @@ /*! \file mln/core/mesh_image.hh * - * \brief Definition of an image class mesh_image. + * \brief Definition of an graph-based image. */ # include <mln/core/internal/image_identity.hh> Index: trunk/milena/mln/core/h_mat.hh =================================================================== --- trunk/milena/mln/core/h_mat.hh (revision 1338) +++ trunk/milena/mln/core/h_mat.hh (revision 1339) @@ -30,8 +30,7 @@ /*! \file mln/core/h_mat.hh * - * \brief Definition of the mln::h_mat alias and of its - * construction routine. + * \brief Definition of a matrix with homogeneous coordinates. */ # include <mln/metal/mat.hh> Index: trunk/milena/mln/core/plain.hh =================================================================== --- trunk/milena/mln/core/plain.hh (revision 1338) +++ trunk/milena/mln/core/plain.hh (revision 1339) @@ -30,7 +30,8 @@ /*! \file mln/core/plain.hh * - * \brief Definition of an image class FIXME + * \brief Definition of a morpher that prevent an image from sharing + * his data. */ # include <cmath> Index: trunk/milena/mln/core/grids.hh =================================================================== --- trunk/milena/mln/core/grids.hh (revision 1338) +++ trunk/milena/mln/core/grids.hh (revision 1339) @@ -30,7 +30,7 @@ /*! \file mln/core/grids.hh * - * \brief This file defines some grid classes. + * \brief Definition of some grid classes. */ # include <mln/core/concept/regular_grid.hh> Index: trunk/milena/mln/core/inplace.hh =================================================================== --- trunk/milena/mln/core/inplace.hh (revision 1338) +++ trunk/milena/mln/core/inplace.hh (revision 1339) @@ -29,7 +29,9 @@ # define MLN_CORE_INPLACE_HH /*! \file mln/core/inplace.hh - * \brief Definition of the mln::inplace routine. + * + * \brief Definition of routine that make temporary objects become + * mutable. */ # include <mln/core/exact.hh> Index: trunk/milena/mln/core/image2d_h.hh =================================================================== --- trunk/milena/mln/core/image2d_h.hh (revision 1338) +++ trunk/milena/mln/core/image2d_h.hh (revision 1339) @@ -28,9 +28,10 @@ #ifndef MLN_CORE_IMAGE2D_H_HH # define MLN_CORE_IMAGE2D_H_HH -/*! \file mln/core/hexa_piter.hh +/*! \file mln/core/image2d_h.hh * - * \brief Definition of iterators on points of pset_ifes. + * \brief Definition of an alias for a 2d image based on an hexagonal + * mesh. */ # include <mln/core/image2d.hh> Index: trunk/milena/mln/convert/to_rgb.hh =================================================================== --- trunk/milena/mln/convert/to_rgb.hh (revision 1338) +++ trunk/milena/mln/convert/to_rgb.hh (revision 1339) @@ -28,7 +28,7 @@ #ifndef MLN_CONVERT_TO_RGB_HH # define MLN_CONVERT_TO_RGB_HH -/*! \file mln/convert/to_window.hh +/*! \file mln/convert/to_rgb.hh * * \brief Conversions to mln::value::rgb. */