[Olena-patches] last-svn-commit-204-g40e46d9 mln/io/vtk/save.hh: Fix documentation.

--- milena/ChangeLog | 4 ++++ milena/mln/io/vtk/save.hh | 38 ++++++++++++++++---------------------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 41c681c..d27ada3 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,7 @@ +2010-07-28 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + + * mln/io/vtk/save.hh: Fix documentation. + 2010-07-27 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; * mln/io/vtk/all.hh: New. diff --git a/milena/mln/io/vtk/save.hh b/milena/mln/io/vtk/save.hh index 10c3f0b..2a4a51f 100644 --- a/milena/mln/io/vtk/save.hh +++ b/milena/mln/io/vtk/save.hh @@ -58,41 +58,35 @@ namespace mln /** \brief Save a (binary) VTK image into a complex image. \param[in] ima The image to save. - \param[in] filename The name of the file where to save the image. - - The image is said binary since data represent only the - existence of faces. */ + \param[in] filename The name of the file where to save the + image. + */ void save(const bin_2complex_image3df& ima, const std::string& filename); - /** \brief Save an 8-bit grey-level VTK image into a complex image. + /** \brief Save an 8-bit gray-level VTK image into a complex image. \param[in] ima The image to save. - \param[in] filename The name of the file where to save the image. - - Only data is attached to 2-faces is saved; the VTK file - cannot store data attached to faces of other dimensions. */ + \param[in] filename The name of the file where to save the + image. + */ void save(const int_u8_2complex_image3df& ima, const std::string& filename); - /** \brief Save a floating-point value grey-level VTK image into + /** \brief Save a floating-point value gray-level VTK image into a complex image. \param[in] ima The image to save. - \param[in] filename The name of the file where to save the image. - - Only data is attached to 2-faces is saved; the VTK file - cannot store data attached to faces of other dimensions. */ + \param[in] filename The name of the file where to save the + image. */ void save(const float_2complex_image3df& ima, const std::string& filename); /** \brief Save a 3x8-bit RGB (color) VTK image into a complex image. \param[in] ima The image to save. - \param[in] filename The name of the file where to save the image. - - Only data is attached to 2-faces is saved; the VTK file - cannot store data attached to faces of other dimensions. */ + \param[in] filename The name of the file where to save the + image. */ void save(const rgb8_2complex_image3df& ima, const std::string& filename); @@ -248,7 +242,7 @@ namespace mln parts.'' */ /* ``1. The first part is the file version and - identifier. This part contains the single line: + identifier. This part contains the single line: # vtk DataFile Version x.x. @@ -268,9 +262,9 @@ namespace mln << std::endl; /* ``3. The next part is the file format. The file format - describes the type of file, either ASCII or - binary. On this line the single word ASCII or BINARY - must appear.'' */ + describes the type of file, either ASCII or + binary. On this line the single word ASCII or BINARY + must appear.'' */ ostr << "ASCII" << std::endl; /*-------. -- 1.5.6.5