[Olena-patches] milena r1340: Update typo

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena ChangeLog: 2007-10-16 Guillaume Duhamel &lt;guillaume.duhamel(a)lrde.epita.fr&gt; Update typo. * mln/core/concept/generalized_pixel.hh, * mln/core/internal/box_impl.hh, * mln/core/internal/coord_impl.hh, * mln/core/pixter3d.hh, * mln/core/queue_p_fast.hh, * mln/core/queue_p_fast_priority.hh, * mln/core/queue_p_priority.hh, * mln/core/rle_encode.hh, * mln/core/rle_image.hh, * mln/core/safe.hh, * mln/core/sparse_encode.hh, * mln/core/sub_image.hh, * mln/core/tr_image.hh, * mln/core/tr_mesh.hh, * mln/core/translate_image.hh, * mln/debug/iota.hh, * mln/debug/println_with_border.hh, * mln/display/color_pretty.hh, * mln/display/save.hh, * mln/display/show.hh, * mln/geom/seeds2tiling.hh, * mln/geom/seeds2tiling_with_chamfer.hh, * mln/geom/shift.hh, * mln/io/fits/load.hh, * mln/io/internal/abort.hh, * mln/io/internal/pnm/load.hh, * mln/io/internal/pnm/load_header.hh, * mln/io/internal/pnm/save.hh, * mln/io/internal/pnm/save_header.hh, * mln/io/pbm/load.hh, * mln/io/pbm/save.hh, * mln/io/pfm/load.hh, * mln/io/pfm/save.hh, * mln/io/pgm/load.hh, * mln/io/pgm/save.hh, * mln/io/ppm/load.hh, * mln/io/ppm/save.hh, * mln/make/vec.hh, * mln/make/voronoi.hh, * mln/make/win_chamfer.hh: Update typo. --- core/concept/generalized_pixel.hh | 2 - core/internal/box_impl.hh | 2 - core/internal/coord_impl.hh | 2 - core/pixter3d.hh | 28 ++++++++++++------------- core/queue_p_fast.hh | 3 +- core/queue_p_fast_priority.hh | 4 +-- core/queue_p_priority.hh | 3 +- core/rle_encode.hh | 2 - core/rle_image.hh | 2 - core/safe.hh | 10 +++++++++ core/sparse_encode.hh | 2 - core/sub_image.hh | 8 +++++++ core/tr_image.hh | 4 ++- core/tr_mesh.hh | 4 ++- core/translate_image.hh | 2 - debug/iota.hh | 2 - debug/println_with_border.hh | 2 - display/color_pretty.hh | 2 - display/save.hh | 4 +-- display/show.hh | 4 +-- geom/seeds2tiling.hh | 3 +- geom/seeds2tiling_with_chamfer.hh | 2 - geom/shift.hh | 2 - io/fits/load.hh | 8 +++++++ io/internal/abort.hh | 7 ++++++ io/internal/pnm/load.hh | 12 ++++++----- io/internal/pnm/load_header.hh | 13 +++++++++--- io/internal/pnm/save.hh | 14 +++++++----- io/internal/pnm/save_header.hh | 13 +++++++++--- io/pbm/load.hh | 9 ++++++++ io/pbm/save.hh | 8 +++++++ io/pfm/load.hh | 8 +++++++ io/pfm/save.hh | 8 +++++++ io/pgm/load.hh | 8 +++++++ io/pgm/save.hh | 8 +++++++ io/ppm/load.hh | 8 +++++++ io/ppm/save.hh | 7 ++++-- make/vec.hh | 2 - make/voronoi.hh | 2 - make/win_chamfer.hh | 41 ++++++++++++++++++++++++++++++++++++++ 40 files changed, 215 insertions(+), 60 deletions(-) Index: trunk/milena/mln/debug/iota.hh =================================================================== --- trunk/milena/mln/debug/iota.hh (revision 1339) +++ trunk/milena/mln/debug/iota.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/debug/iota.hh * - * \brief FIXME + * \brief Fill an image with successive values. */ # include <mln/core/concept/image.hh> Index: trunk/milena/mln/debug/println_with_border.hh =================================================================== --- trunk/milena/mln/debug/println_with_border.hh (revision 1339) +++ trunk/milena/mln/debug/println_with_border.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/debug/println_with_border.hh * - * \brief Print an image on the standard output. + * \brief Print an image on the standard output with its border. */ # include <mln/core/concept/image.hh> Index: trunk/milena/mln/core/translate_image.hh =================================================================== --- trunk/milena/mln/core/translate_image.hh (revision 1339) +++ trunk/milena/mln/core/translate_image.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/core/translate_image.hh * - * \brief Definition of a translated image. + * \brief Definition of an image which be translated by a delta point. */ # include <cmath> Index: trunk/milena/mln/core/sparse_encode.hh =================================================================== --- trunk/milena/mln/core/sparse_encode.hh (revision 1339) +++ trunk/milena/mln/core/sparse_encode.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/core/sparse_encode.hh * - * \brief FIXME + * \brief FIXME. */ # include <mln/core/sparse_image.hh> Index: trunk/milena/mln/core/internal/coord_impl.hh =================================================================== --- trunk/milena/mln/core/internal/coord_impl.hh (revision 1339) +++ trunk/milena/mln/core/internal/coord_impl.hh (revision 1340) @@ -30,8 +30,6 @@ /*! \file mln/core/internal/coord_impl.hh * - * \internal - * * \brief Define some implementation classes for generalized points. */ Index: trunk/milena/mln/core/internal/box_impl.hh =================================================================== --- trunk/milena/mln/core/internal/box_impl.hh (revision 1339) +++ trunk/milena/mln/core/internal/box_impl.hh (revision 1340) @@ -30,8 +30,6 @@ /*! \file mln/core/internal/box_impl.hh * - * \internal - * * \brief Define some implementation classes to provide methods * related to classes having a bounding box. */ Index: trunk/milena/mln/core/queue_p_fast.hh =================================================================== --- trunk/milena/mln/core/queue_p_fast.hh (revision 1339) +++ trunk/milena/mln/core/queue_p_fast.hh (revision 1340) @@ -30,7 +30,8 @@ /*! \file mln/core/queue_p_fast.hh * - * \brief Definition of a point set class based on std::deque. + * \brief Definition of a point set class faster but needs more memory + * space. */ # include <vector> Index: trunk/milena/mln/core/queue_p_fast_priority.hh =================================================================== --- trunk/milena/mln/core/queue_p_fast_priority.hh (revision 1339) +++ trunk/milena/mln/core/queue_p_fast_priority.hh (revision 1340) @@ -30,8 +30,8 @@ /*! \file mln/core/queue_p_fast_priority.hh * - * \brief Definition of a point set class based on std::deque - * and std::map. + * \brief Definition of a point set class based on queue_p_fast with + * priority features. */ # include <vector> Index: trunk/milena/mln/core/rle_image.hh =================================================================== --- trunk/milena/mln/core/rle_image.hh (revision 1339) +++ trunk/milena/mln/core/rle_image.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/core/rle_image.hh * - * \brief Definition of mln::rle_image + * \brief Definition of an image with rle encoding. */ # include <mln/core/internal/run_image.hh> Index: trunk/milena/mln/core/tr_image.hh =================================================================== --- trunk/milena/mln/core/tr_image.hh (revision 1339) +++ trunk/milena/mln/core/tr_image.hh (revision 1340) @@ -30,7 +30,9 @@ /*! \file mln/core/tr_image.hh * - * \brief Definition of an image class FIXME + * \brief Definition of a morpher that makes an image become + * transformed by a given transformation. + * */ # include <cmath> Index: trunk/milena/mln/core/queue_p_priority.hh =================================================================== --- trunk/milena/mln/core/queue_p_priority.hh (revision 1339) +++ trunk/milena/mln/core/queue_p_priority.hh (revision 1340) @@ -30,7 +30,8 @@ /*! \file mln/core/queue_p_priority.hh * - * \brief Definition of a point set class based on std::deque. + * \brief Definition of a point set class based on queue_p with + * priority features. */ # include <vector> Index: trunk/milena/mln/core/pixter3d.hh =================================================================== --- trunk/milena/mln/core/pixter3d.hh (revision 1339) +++ trunk/milena/mln/core/pixter3d.hh (revision 1340) @@ -64,22 +64,22 @@ private: /// Twice the size of the image border. - unsigned border_x2_; + const unsigned border_x2_; /// Row offset. - unsigned row_offset_; + const unsigned row_offset_; /// End of the current row. mln_qlf_value(I)* eor_; ///Next Slide offset for row. - unsigned next_srow_offset_; + const unsigned next_srow_offset_; /// Next Slide offset. - unsigned next_sli_offset_; + const unsigned next_sli_offset_; /// Slide offset. - unsigned sli_offset_; + const unsigned sli_offset_; /// End of the current slide. mln_qlf_value(I)* eos_; @@ -92,17 +92,17 @@ #ifndef MLN_INCLUDE_ONLY template <typename I> - fwd_pixter3d<I>::fwd_pixter3d(I& image) : - super_(image) + fwd_pixter3d<I>::fwd_pixter3d(I& image) + : super_(image), + border_x2_ (2 * image.border()), + row_offset_ (image.bbox().ncols() + border_x2_), + eor_ (& image.at(geom::min_sli(image), geom::min_row(image), geom::max_col(image)) + 1), + next_srow_offset_ ((image.bbox().ncols() + border_x2_) * border_x2_ ), + next_sli_offset_ (row_offset_ * border_x2_), + sli_offset_ ((image.bbox().ncols() + border_x2_) * (image.bbox().nrows() + border_x2_)), + eos_ (& image.at(geom::min_sli(image), geom::max_row(image) + 1, geom::min_col(image))) { mln_precondition(image.has_data()); - border_x2_ = 2 * image.border(); - row_offset_ = geom::max_col(image) - geom::min_col(image) + 1 + border_x2_; - eor_ = & image.at(geom::min_sli(image), geom::min_row(image), geom::max_col(image)) + 1; - next_sli_offset_ = 4 * image.border() * image.bbox().ncols() + 2 * image.border(); - sli_offset_ = (image.bbox().ncols() + border_x2_) * (image.bbox().nrows() + border_x2_); - eos_ = & image.at(geom::min_sli(image), geom::max_row(image) + 1, geom::min_col(image)); - next_srow_offset_ = (image.bbox().ncols() + border_x2_) * border_x2_; } template <typename I> Index: trunk/milena/mln/core/safe.hh =================================================================== --- trunk/milena/mln/core/safe.hh (revision 1339) +++ trunk/milena/mln/core/safe.hh (revision 1340) @@ -28,9 +28,19 @@ #ifndef MLN_CORE_SAFE_HH # define MLN_CORE_SAFE_HH +/*! + * \file safe.hh + * + * \brief Definition of a morpher that makes image become accessible + * at undefined location. + * + */ + + # include <mln/core/internal/image_identity.hh> + namespace mln { Index: trunk/milena/mln/core/sub_image.hh =================================================================== --- trunk/milena/mln/core/sub_image.hh (revision 1339) +++ trunk/milena/mln/core/sub_image.hh (revision 1340) @@ -28,6 +28,14 @@ #ifndef MLN_CORE_SUB_IMAGE_HH # define MLN_CORE_SUB_IMAGE_HH +/*! + * \file sub_image.hh + * + * \brief Definition of morpher that makes an image become restricted + * given by a point set. + * + */ + # include <mln/core/internal/image_domain_morpher.hh> Index: trunk/milena/mln/core/concept/generalized_pixel.hh =================================================================== --- trunk/milena/mln/core/concept/generalized_pixel.hh (revision 1339) +++ trunk/milena/mln/core/concept/generalized_pixel.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/core/concept/generalized_pixel.hh * - * \brief Definition of the concept of mln::Genpixel. + * \brief Definition of the concept of mln::Generalized_Pixel. */ # include <mln/core/concept/object.hh> Index: trunk/milena/mln/core/rle_encode.hh =================================================================== --- trunk/milena/mln/core/rle_encode.hh (revision 1339) +++ trunk/milena/mln/core/rle_encode.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/core/rle_encode.hh * - * \brief FIXME + * \brief Definintion of function which encodes an image in rle_image. */ # include <mln/core/sparse_image.hh> Index: trunk/milena/mln/core/tr_mesh.hh =================================================================== --- trunk/milena/mln/core/tr_mesh.hh (revision 1339) +++ trunk/milena/mln/core/tr_mesh.hh (revision 1340) @@ -29,7 +29,9 @@ # define MLN_CORE_TR_MESH_HH /*! \file mln/core/tr_mesh.hh - * \brief Definition of mln::tr_mesh. + * + * \brief Definition of a mesh that is transformed by a given + * transformation. */ # include <mln/core/concept/mesh.hh> Index: trunk/milena/mln/make/win_chamfer.hh =================================================================== --- trunk/milena/mln/make/win_chamfer.hh (revision 1339) +++ trunk/milena/mln/make/win_chamfer.hh (revision 1340) @@ -1,3 +1,42 @@ +// Copyright (C) 2006 EPITA Research and Development Laboratory +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to +// produce an executable, this file does not by itself cause the +// resulting executable to be covered by the GNU General Public +// License. This exception does not however invalidate any other +// reasons why the executable file might be covered by the GNU General +// Public License. + + +#ifndef MLN_MAKE_WIN_CHAMFER_HH +# define MLN_MAKE_WIN_CHAMFER_HH\ + +/*! + * \file mln/make/win_chamfer.hh + * + * \brief Routine to create chamfer mln::w_window2d_int. + * + */ + + # include <mln/core/w_window2d_int.hh> # include <mln/core/w_window2d_float.hh> # include <math.h> @@ -67,3 +106,5 @@ } // end of mln::win_chamfer } // end of mln + +#endif // ! MLN_MAKE_WIN_CHAMFER_HH Index: trunk/milena/mln/make/voronoi.hh =================================================================== --- trunk/milena/mln/make/voronoi.hh (revision 1339) +++ trunk/milena/mln/make/voronoi.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/make/voronoi.hh * - * \brief Routine to construct an mln::make::voronoi. + * \brief Routine to construct a voronoi mln::mesh_p. */ # include <vector> Index: trunk/milena/mln/make/vec.hh =================================================================== --- trunk/milena/mln/make/vec.hh (revision 1339) +++ trunk/milena/mln/make/vec.hh (revision 1340) @@ -132,4 +132,4 @@ } // end of namespace mln -#endif // ! MLN_METAL_VEC_HH +#endif // ! MLN_MAKE_VEC_HH Index: trunk/milena/mln/geom/seeds2tiling.hh =================================================================== --- trunk/milena/mln/geom/seeds2tiling.hh (revision 1339) +++ trunk/milena/mln/geom/seeds2tiling.hh (revision 1340) @@ -30,7 +30,8 @@ /*! \file mln/geom/seeds2tiling.hh * - * \brief . + * \brief Definition of a function which takes a labeled image and + * returns an image which has blew up its labeled values. */ # include <map> Index: trunk/milena/mln/geom/seeds2tiling_with_chamfer.hh =================================================================== --- trunk/milena/mln/geom/seeds2tiling_with_chamfer.hh (revision 1339) +++ trunk/milena/mln/geom/seeds2tiling_with_chamfer.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/geom/seeds2tiling_with_chamfer.hh * - * \brief . + * \brief FIXME. */ # include <map> Index: trunk/milena/mln/geom/shift.hh =================================================================== --- trunk/milena/mln/geom/shift.hh (revision 1339) +++ trunk/milena/mln/geom/shift.hh (revision 1340) @@ -30,7 +30,7 @@ /*! \file mln/geom/shift.hh * - * \brief Shift. + * \brief Define a function which shifts a window with a delta-point. */ # include <mln/core/window.hh> Index: trunk/milena/mln/display/color_pretty.hh =================================================================== --- trunk/milena/mln/display/color_pretty.hh (revision 1339) +++ trunk/milena/mln/display/color_pretty.hh (revision 1340) @@ -31,7 +31,7 @@ /*! \file mln/display/color_pretty.hh * * \brief Create a pretty image, which display its content - * with red value for non-defined point site. + * with red value for undefined point site. */ # include <mln/trait/image_from_mesh.hh> Index: trunk/milena/mln/display/save.hh =================================================================== --- trunk/milena/mln/display/save.hh (revision 1339) +++ trunk/milena/mln/display/save.hh (revision 1340) @@ -30,8 +30,8 @@ /*! \file mln/display/save.hh * - * \brief Create a pretty image, which display its content - * with red value for non-defined point site. + * \brief Definition of function which saves an image on a temporary + * files. */ # include <mln/trait/image_from_mesh.hh> Index: trunk/milena/mln/display/show.hh =================================================================== --- trunk/milena/mln/display/show.hh (revision 1339) +++ trunk/milena/mln/display/show.hh (revision 1340) @@ -30,8 +30,8 @@ /*! \file mln/display/show.hh * - * \brief Create a pretty image, which display its content - * with red value for non-defined point site. + * \brief Display the temporary image which has just been saved with + * given viewer (default xv). */ # include <mln/trait/image_from_mesh.hh> Index: trunk/milena/mln/io/pfm/save.hh =================================================================== --- trunk/milena/mln/io/pfm/save.hh (revision 1339) +++ trunk/milena/mln/io/pfm/save.hh (revision 1340) @@ -29,6 +29,14 @@ #ifndef MLN_IO_PFM_SAVE_HH # define MLN_IO_PFM_SAVE_HH +/*! + * \file mln/io/pfm/save.hh + * + * \brief Define a function which saves an image of kind pfm into + * given path. + * + */ + # include <iostream> # include <fstream> Index: trunk/milena/mln/io/pfm/load.hh =================================================================== --- trunk/milena/mln/io/pfm/load.hh (revision 1339) +++ trunk/milena/mln/io/pfm/load.hh (revision 1340) @@ -29,6 +29,14 @@ #ifndef MLN_IO_PFM_LOAD_HH # define MLN_IO_PFM_LOAD_HH +/*! + * \file mln/io/pfm/load.hh + * + * \brief Define a function which loads an image of kind pfm with + * given path. + * + */ + // # include <iostream> // # include <fstream> // # include <string> Index: trunk/milena/mln/io/pgm/save.hh =================================================================== --- trunk/milena/mln/io/pgm/save.hh (revision 1339) +++ trunk/milena/mln/io/pgm/save.hh (revision 1340) @@ -29,6 +29,14 @@ #ifndef MLN_IO_PGM_SAVE_HH # define MLN_IO_PGM_SAVE_HH +/*! + * \file mln/io/pgm/save.hh + * + * \brief Define a function which saves an image of kind pgm into + * given path. + * + */ + # include <iostream> # include <fstream> Index: trunk/milena/mln/io/pgm/load.hh =================================================================== --- trunk/milena/mln/io/pgm/load.hh (revision 1339) +++ trunk/milena/mln/io/pgm/load.hh (revision 1340) @@ -29,6 +29,14 @@ #ifndef MLN_IO_PGM_LOAD_HH # define MLN_IO_PGM_LOAD_HH +/*! + * \file mln/io/pgm/load.hh + * + * \brief Define a function which loads an image of kind pgm with + * given path. + * + */ + # include <iostream> # include <fstream> # include <string> Index: trunk/milena/mln/io/fits/load.hh =================================================================== --- trunk/milena/mln/io/fits/load.hh (revision 1339) +++ trunk/milena/mln/io/fits/load.hh (revision 1340) @@ -29,6 +29,14 @@ #ifndef MLN_IO_FITS_LOAD_HH # define MLN_IO_FITS_LOAD_HH +/*! + * \file mln/io/fits/load.hh + * + * \brief Define a function which loads an image of kind fits with + * given path. + * + */ + # include <iostream> # include <fstream> # include <string> Index: trunk/milena/mln/io/internal/abort.hh =================================================================== --- trunk/milena/mln/io/internal/abort.hh (revision 1339) +++ trunk/milena/mln/io/internal/abort.hh (revision 1340) @@ -29,6 +29,13 @@ #ifndef MLN_IO_ABORT_HH # define MLN_IO_ABORT_HH +/*! + * \file mln/io/abort.hh + * + * \brief Define a function which aborts a process in io module. + * + */ + namespace mln { Index: trunk/milena/mln/io/internal/pnm/save_header.hh =================================================================== --- trunk/milena/mln/io/internal/pnm/save_header.hh (revision 1339) +++ trunk/milena/mln/io/internal/pnm/save_header.hh (revision 1340) @@ -26,8 +26,15 @@ // reasons why the executable file might be covered by the GNU General // Public License. -#ifndef MLN_IO_PNM_SAVE_HEADER_HH -# define MLN_IO_PNM_SAVE_HEADER_HH +#ifndef MLN_IO_INTERNAL_PNM_SAVE_HEADER_HH +# define MLN_IO_INTERNAL_PNM_SAVE_HEADER_HH + +/*! + * \file mln/io/internal/pnm/save_header.hh + * + * \brief Define a function which saves header for PNM image. + * + */ # include <iostream> # include <fstream> @@ -95,4 +102,4 @@ } // end of namespace mln -#endif // ! MLN_IO_PNM_SAVE_HEADER_HH +#endif // ! MLN_IO_INTERNAL_PNM_SAVE_HEADER_HH Index: trunk/milena/mln/io/internal/pnm/load_header.hh =================================================================== --- trunk/milena/mln/io/internal/pnm/load_header.hh (revision 1339) +++ trunk/milena/mln/io/internal/pnm/load_header.hh (revision 1340) @@ -26,8 +26,15 @@ // reasons why the executable file might be covered by the GNU General // Public License. -#ifndef MLN_IO_PNM_LOAD_HEADER_HH -# define MLN_IO_PNM_LOAD_HEADER_HH +#ifndef MLN_IO_INTERNAL_PNM_LOAD_HEADER_HH +# define MLN_IO_INTERNAL_PNM_LOAD_HEADER_HH + +/*! + * \file mln/io/internal/pnm/load_header.hh + * + * \brief Define a function which loads header for PNM image. + * + */ # include <iostream> # include <fstream> @@ -130,4 +137,4 @@ } // end of namespace mln -#endif // ! MLN_IO_PNM_LOAD_HEADER_HH +#endif // ! MLN_IO_INTERNAL_PNM_LOAD_HEADER_HH Index: trunk/milena/mln/io/internal/pnm/save.hh =================================================================== --- trunk/milena/mln/io/internal/pnm/save.hh (revision 1339) +++ trunk/milena/mln/io/internal/pnm/save.hh (revision 1340) @@ -26,12 +26,14 @@ // reasons why the executable file might be covered by the GNU General // Public License. -#ifndef MLN_IO_PNM_SAVE_HH -# define MLN_IO_PNM_SAVE_HH +#ifndef MLN_IO_INTERNAL_PNM_SAVE_HH +# define MLN_IO_INTERNAL_PNM_SAVE_HH -/*! \file mln/io/internal/pnm/save.hh +/*! + * \file mln/io/internal/pnm/save.hh * - * \brief function to save PNM images, + * \brief Define a function which saves an image of kind PNM into + * given path. * */ @@ -175,11 +177,11 @@ } // end of namespace mln::io::internal::pnm - } // end of namespace mln::internal + } // end of namespace mln::io::internal } // end of namespace mln::io } // end of namespace mln -#endif // ! MLN_IO_PNM_SAVE_HH +#endif // ! MLN_IO_INTERNAL_PNM_SAVE_HH Index: trunk/milena/mln/io/internal/pnm/load.hh =================================================================== --- trunk/milena/mln/io/internal/pnm/load.hh (revision 1339) +++ trunk/milena/mln/io/internal/pnm/load.hh (revision 1340) @@ -26,12 +26,14 @@ // reasons why the executable file might be covered by the GNU General // Public License. -#ifndef MLN_IO_PNM_LOAD_HH -# define MLN_IO_PNM_LOAD_HH +#ifndef MLN_IO_INTERNAL_PNM_LOAD_HH +# define MLN_IO_INTERNAL_PNM_LOAD_HH -/*! \file mln/io/internal/pnm/load.hh +/*! + * \file mln/io/internal/pnm/load.hh * - * \brief load a PNM 8/16bits image + * \brief Define a function which loads an image of kind PNM 8/16bits with + * given path. */ # include <iostream> @@ -228,4 +230,4 @@ } // end of namespace mln -#endif // ! MLN_IO_PNM_LOAD_HH +#endif // ! MLN_IO_INTERNAL_PNM_LOAD_HH Index: trunk/milena/mln/io/ppm/save.hh =================================================================== --- trunk/milena/mln/io/ppm/save.hh (revision 1339) +++ trunk/milena/mln/io/ppm/save.hh (revision 1340) @@ -29,9 +29,12 @@ #ifndef MLN_IO_PPM_SAVE_HH # define MLN_IO_PPM_SAVE_HH -/*! \file mln/io/ppm/save.hh +/*! + * \file mln/io/ppm/save.hh + * + * \brief Define a function which saves an image of kind ppm into + * given path. * - * \brief save a PPM image. */ # include <mln/core/concept/image.hh> Index: trunk/milena/mln/io/ppm/load.hh =================================================================== --- trunk/milena/mln/io/ppm/load.hh (revision 1339) +++ trunk/milena/mln/io/ppm/load.hh (revision 1340) @@ -29,6 +29,14 @@ #ifndef MLN_IO_PPM_LOAD_HH # define MLN_IO_PPM_LOAD_HH +/*! + * \file mln/io/ppm/load.hh + * + * \brief Define a function which loads an image of kind ppm with + * given path. + * + */ + # include <iostream> # include <fstream> # include <string> Index: trunk/milena/mln/io/pbm/save.hh =================================================================== --- trunk/milena/mln/io/pbm/save.hh (revision 1339) +++ trunk/milena/mln/io/pbm/save.hh (revision 1340) @@ -29,6 +29,14 @@ #ifndef MLN_IO_PBM_SAVE_HH # define MLN_IO_PBM_SAVE_HH +/*! + * \file mln/io/pbm/save.hh + * + * \brief Define a function which saves an image of kind pbm into + * given path. + * + */ + # include <iostream> # include <fstream> Index: trunk/milena/mln/io/pbm/load.hh =================================================================== --- trunk/milena/mln/io/pbm/load.hh (revision 1339) +++ trunk/milena/mln/io/pbm/load.hh (revision 1340) @@ -29,6 +29,15 @@ #ifndef MLN_IO_PBM_LOAD_HH # define MLN_IO_PBM_LOAD_HH +/*! + * \file mln/io/pbm/load.hh + * + * \brief Define a function which loads an image of kind pbm with + * given path. + * + */ + + # include <iostream> # include <fstream> # include <string>