[Olena-patches] [PATCH 21/27] Fix some Doxygen comments in mln/io/.

* mln/io/all.hh, * mln/io/cloud/all.hh, * mln/io/dump/all.hh, * mln/io/essential.hh, * mln/io/fits/all.hh, * mln/io/magick/all.hh, * mln/io/off/all.hh, * mln/io/pbm/all.hh, * mln/io/pfm/all.hh, * mln/io/pgm/all.hh, * mln/io/plot/all.hh, * mln/io/plot/load.hh, * mln/io/plot/save.hh, * mln/io/pnm/all.hh, * mln/io/ppm/all.hh, * mln/io/tiff/all.hh, * mln/io/txt/all.hh: Here. --- milena/ChangeLog | 23 +++++++++++++++++++++++ milena/mln/io/all.hh | 6 +++--- milena/mln/io/cloud/all.hh | 3 +-- milena/mln/io/dump/all.hh | 3 +-- milena/mln/io/essential.hh | 3 +-- milena/mln/io/fits/all.hh | 6 ++---- milena/mln/io/magick/all.hh | 6 ++---- milena/mln/io/off/all.hh | 6 ++---- milena/mln/io/pbm/all.hh | 5 ++--- milena/mln/io/pfm/all.hh | 6 ++---- milena/mln/io/pgm/all.hh | 6 ++---- milena/mln/io/plot/all.hh | 3 +-- milena/mln/io/plot/load.hh | 1 - milena/mln/io/plot/save.hh | 1 - milena/mln/io/pnm/all.hh | 6 ++---- milena/mln/io/ppm/all.hh | 6 ++---- milena/mln/io/tiff/all.hh | 3 +-- milena/mln/io/txt/all.hh | 6 ++---- 18 files changed, 49 insertions(+), 50 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 8560482..bfbfd3c 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,26 @@ +2009-06-03 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + + Fix some Doxygen comments in mln/io/. + + * mln/io/all.hh, + * mln/io/cloud/all.hh, + * mln/io/dump/all.hh, + * mln/io/essential.hh, + * mln/io/fits/all.hh, + * mln/io/magick/all.hh, + * mln/io/off/all.hh, + * mln/io/pbm/all.hh, + * mln/io/pfm/all.hh, + * mln/io/pgm/all.hh, + * mln/io/plot/all.hh, + * mln/io/plot/load.hh, + * mln/io/plot/save.hh, + * mln/io/pnm/all.hh, + * mln/io/ppm/all.hh, + * mln/io/tiff/all.hh, + * mln/io/txt/all.hh: + Here. + 2009-06-02 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; Add tentative support for GDCM in the build system. diff --git a/milena/mln/io/all.hh b/milena/mln/io/all.hh index 767cd7d..c7afa9a 100644 --- a/milena/mln/io/all.hh +++ b/milena/mln/io/all.hh @@ -29,9 +29,7 @@ # define MLN_IO_ALL_HH /// \file mln/io/all.hh -/// -/// File that includes all io materials. - +/// \brief Inclusion of all I/O routines. namespace mln @@ -46,6 +44,7 @@ namespace mln } + /*-----------------------. | Built-in I/O support. | `-----------------------*/ @@ -61,6 +60,7 @@ namespace mln # include <mln/io/txt/all.hh> # include <mln/io/off/all.hh> + /*--------------------------------------------------. | I/O routines depending on a third-party library. | `--------------------------------------------------*/ diff --git a/milena/mln/io/cloud/all.hh b/milena/mln/io/cloud/all.hh index f3bceb4..7ecedbd 100644 --- a/milena/mln/io/cloud/all.hh +++ b/milena/mln/io/cloud/all.hh @@ -29,8 +29,7 @@ # define MLN_IO_CLOUD_ALL_HH /// \file mln/io/cloud/all.hh -/// -/// File that includes all cloud io materials. +/// \brief Inclusion of all cloud I/O routines. namespace mln diff --git a/milena/mln/io/dump/all.hh b/milena/mln/io/dump/all.hh index 97fc972..104a0f7 100644 --- a/milena/mln/io/dump/all.hh +++ b/milena/mln/io/dump/all.hh @@ -29,8 +29,7 @@ # define MLN_IO_DUMP_ALL_HH /// \file mln/io/dump/all.hh -/// -/// File that includes all dump io materials. +/// \brief Inclusion of all dump I/O routines. namespace mln diff --git a/milena/mln/io/essential.hh b/milena/mln/io/essential.hh index 2b5199e..bf63057 100644 --- a/milena/mln/io/essential.hh +++ b/milena/mln/io/essential.hh @@ -30,8 +30,7 @@ # define MLN_IO_ESSENTIAL_HH_ /// \file mln/io/essential.hh -/// -/// File that includes the most useful io routines. +/// \brief Inclusion of the most useful I/O routines. # include <mln/io/pbm/all.hh> # include <mln/io/pgm/all.hh> diff --git a/milena/mln/io/fits/all.hh b/milena/mln/io/fits/all.hh index 27aee26..40991b2 100644 --- a/milena/mln/io/fits/all.hh +++ b/milena/mln/io/fits/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_FITS_ALL_HH # define MLN_IO_FITS_ALL_HH -/*! \file mln/io/fits/all.hh - * - * \brief File that includes all fits io materials. - */ +/// \file mln/io/fits/all.hh +/// \brief Inclusion of all FITS I/O routines. namespace mln diff --git a/milena/mln/io/magick/all.hh b/milena/mln/io/magick/all.hh index 545a9fd..45de455 100644 --- a/milena/mln/io/magick/all.hh +++ b/milena/mln/io/magick/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_MAGICK_ALL_HH # define MLN_IO_MAGICK_ALL_HH -/*! \file mln/io/magick/all.hh - * - * \brief File that includes all magick io materials. - */ +/// \file mln/io/magick/all.hh +/// \brief Inclusion of all Magick++ I/O routines. namespace mln diff --git a/milena/mln/io/off/all.hh b/milena/mln/io/off/all.hh index d49081b..1ee3871 100644 --- a/milena/mln/io/off/all.hh +++ b/milena/mln/io/off/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_OFF_ALL_HH # define MLN_IO_OFF_ALL_HH -/*! \file mln/io/off/all.hh - * - * \brief File that includes all off io materials. - */ +/// \file mln/io/off/all.hh +/// \brief Inclusion of all OFF I/O routines. namespace mln diff --git a/milena/mln/io/pbm/all.hh b/milena/mln/io/pbm/all.hh index 17bd044..30c14d3 100644 --- a/milena/mln/io/pbm/all.hh +++ b/milena/mln/io/pbm/all.hh @@ -30,8 +30,7 @@ # define MLN_IO_PBM_ALL_HH /// \file mln/io/pbm/all.hh -/// -/// File that includes all pbm io materials. +/// \brief Inclusion of all PBM I/O routines. namespace mln @@ -42,7 +41,7 @@ namespace mln /// Namespace of pbm input/output handling. namespace pbm { - /// Namespace of pbm's implementation details. + /// Namespace of pbm implementation details. namespace impl {} /// Internal namespace of pbm namespace. diff --git a/milena/mln/io/pfm/all.hh b/milena/mln/io/pfm/all.hh index 0ca3dce..43f2383 100644 --- a/milena/mln/io/pfm/all.hh +++ b/milena/mln/io/pfm/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_PFM_ALL_HH # define MLN_IO_PFM_ALL_HH -/*! \file mln/io/pfm/all.hh - * - * \brief File that includes all pfm io materials. - */ +/// \file mln/io/pfm/all.hh +/// \brief Inclusion of all PFM I/O routines. namespace mln diff --git a/milena/mln/io/pgm/all.hh b/milena/mln/io/pgm/all.hh index df1fa4b..32f3b84 100644 --- a/milena/mln/io/pgm/all.hh +++ b/milena/mln/io/pgm/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_PGM_ALL_HH # define MLN_IO_PGM_ALL_HH -/*! \file mln/io/pgm/all.hh - * - * \brief File that includes all pgm io materials. - */ +/// \file mln/io/pgm/all.hh +/// \brief Inclusion of all PGM I/O routines. namespace mln diff --git a/milena/mln/io/plot/all.hh b/milena/mln/io/plot/all.hh index 36a0d20..8680370 100644 --- a/milena/mln/io/plot/all.hh +++ b/milena/mln/io/plot/all.hh @@ -29,8 +29,7 @@ # define MLN_IO_PLOT_ALL_HH /// \file mln/io/plot/all.hh -/// -/// File that includes all plot io materials. +/// \brief Inclusion of all plot I/O routines. namespace mln diff --git a/milena/mln/io/plot/load.hh b/milena/mln/io/plot/load.hh index a268440..8d5744a 100644 --- a/milena/mln/io/plot/load.hh +++ b/milena/mln/io/plot/load.hh @@ -28,7 +28,6 @@ #ifndef MLN_IO_PLOT_LOAD_HH # define MLN_IO_PLOT_LOAD_HH -/// /// \file mln/io/plot/load.hh /// /// Define a routine which loads in a plot format. diff --git a/milena/mln/io/plot/save.hh b/milena/mln/io/plot/save.hh index 1dead97..5e240fb 100644 --- a/milena/mln/io/plot/save.hh +++ b/milena/mln/io/plot/save.hh @@ -28,7 +28,6 @@ #ifndef MLN_IO_PLOT_SAVE_HH # define MLN_IO_PLOT_SAVE_HH -/// /// \file mln/io/plot/save.hh /// /// Define a routine which saves in a plot format. diff --git a/milena/mln/io/pnm/all.hh b/milena/mln/io/pnm/all.hh index 08f190a..be0c6a2 100644 --- a/milena/mln/io/pnm/all.hh +++ b/milena/mln/io/pnm/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_PNM_ALL_HH # define MLN_IO_PNM_ALL_HH -/*! \file mln/io/pnm/all.hh - * - * \brief File that includes all pnm io materials. - */ +/// \file mln/io/pnm/all.hh +/// \brief Inclusion of all PNM I/O routines. namespace mln diff --git a/milena/mln/io/ppm/all.hh b/milena/mln/io/ppm/all.hh index 64cda0f..bafc19e 100644 --- a/milena/mln/io/ppm/all.hh +++ b/milena/mln/io/ppm/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_PPM_ALL_HH # define MLN_IO_PPM_ALL_HH -/*! \file mln/io/ppm/all.hh - * - * \brief File that includes all ppm io materials. - */ +/// \file mln/io/ppm/all.hh +/// \brief Inclusion of all PPM I/O routines. namespace mln diff --git a/milena/mln/io/tiff/all.hh b/milena/mln/io/tiff/all.hh index 1fbf8fe..e79a366 100644 --- a/milena/mln/io/tiff/all.hh +++ b/milena/mln/io/tiff/all.hh @@ -29,8 +29,7 @@ # define MLN_IO_TIFF_ALL_HH /// \file mln/io/tiff/all.hh -/// -/// File that includes all tiff io materials. +/// \brief Inclusion of all TIFF I/O routines. namespace mln diff --git a/milena/mln/io/txt/all.hh b/milena/mln/io/txt/all.hh index eac9c2f..afd2417 100644 --- a/milena/mln/io/txt/all.hh +++ b/milena/mln/io/txt/all.hh @@ -28,10 +28,8 @@ #ifndef MLN_IO_TXT_ALL_HH # define MLN_IO_TXT_ALL_HH -/*! \file mln/io/txt/all.hh - * - * \brief File that includes all txt io materials. - */ +/// \file mln/io/txt/all.hh +/// \brief Inclusion of all TXT I/O routines. namespace mln -- 1.6.1.2