[Olena-patches] [PATCH 3/5] Clean up Swilena a bit.

* python-utils.ixx (generate__str__): Do not include C++ header `string'. * image2d_int.i, * image2d_int_u8.i, * image2d_rgb8.i: Fix the Swilena documentation headers. * int_u.ixx, * rgb.ixx, * image2d.ixx: More Doxygen documentation. * concat.ixx: Typo in comment. * box_piter.ixx: Remove a blank line. --- swilena/ChangeLog | 17 +++++++++++++++++ swilena/box_piter.ixx | 3 +-- swilena/concat.ixx | 4 ++-- swilena/image2d.ixx | 2 +- swilena/image2d_int.i | 5 +++-- swilena/image2d_int_u8.i | 5 +++-- swilena/image2d_rgb8.i | 2 +- swilena/int_u.ixx | 24 ++++++++++++++---------- swilena/python-utils.ixx | 3 +-- swilena/rgb.ixx | 20 ++++++++++++-------- 10 files changed, 55 insertions(+), 30 deletions(-) diff --git a/swilena/ChangeLog b/swilena/ChangeLog index 7f987ec..e751084 100644 --- a/swilena/ChangeLog +++ b/swilena/ChangeLog @@ -1,5 +1,22 @@ 2010-04-08 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Clean up Swilena a bit. + + * python-utils.ixx (generate__str__): + Do not include C++ header `string'. + * image2d_int.i, + * image2d_int_u8.i, + * image2d_rgb8.i: + Fix the Swilena documentation headers. + * int_u.ixx, + * rgb.ixx, + * image2d.ixx: + More Doxygen documentation. + * concat.ixx: Typo in comment. + * box_piter.ixx: Remove a blank line. + +2010-04-08 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Wrap a subset of complexes' features. * complex.ixx, complex2.i: New. diff --git a/swilena/box_piter.ixx b/swilena/box_piter.ixx index 032ef7d..f1cc79e 100644 --- a/swilena/box_piter.ixx +++ b/swilena/box_piter.ixx @@ -1,5 +1,5 @@ // -*- C++ -*- -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -30,7 +30,6 @@ %module box_piter %{ - #include "mln/core/site_set/box_piter.hh" %} diff --git a/swilena/concat.ixx b/swilena/concat.ixx index 220a609..18050a9 100644 --- a/swilena/concat.ixx +++ b/swilena/concat.ixx @@ -1,5 +1,5 @@ // -*- C++ -*- -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -28,7 +28,7 @@ /// \brief Macros concatenating their arguments. /// /// These macros are useful to wrap strings containing commas and -/// passed as arguments other macros. For instance, to pass the +/// passed as arguments to other macros. For instance, to pass the /// argument <tt>Bar<int, float></tt> to a macro /// <tt>instantiate_foo</tt> taking a single argument, use this: /// diff --git a/swilena/image2d.ixx b/swilena/image2d.ixx index 702bc74..a08864b 100644 --- a/swilena/image2d.ixx +++ b/swilena/image2d.ixx @@ -62,7 +62,7 @@ // mln::image2d definition. %include "mln/core/image/image2d.hh" -// FIXME: Doc. +// Generate a wrapper of mln::image2d<T> named I. %define instantiate_image2d(I, T) /* Add a setter, since Python does not seem to allow writings like diff --git a/swilena/image2d_int.i b/swilena/image2d_int.i index ac82fe6..10e1afb 100644 --- a/swilena/image2d_int.i +++ b/swilena/image2d_int.i @@ -1,5 +1,6 @@ // -*- C++ -*- -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -24,7 +25,7 @@ // exception does not however invalidate any other reasons why the // executable file might be covered by the GNU General Public License. -/// \file image2d.i +/// \file image2d_int.i /// \brief A simple wrapping of mln::image2d<int> along with some /// algorithms. diff --git a/swilena/image2d_int_u8.i b/swilena/image2d_int_u8.i index 109f8bc..18b4f84 100644 --- a/swilena/image2d_int_u8.i +++ b/swilena/image2d_int_u8.i @@ -1,5 +1,6 @@ // -*- C++ -*- -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -24,7 +25,7 @@ // exception does not however invalidate any other reasons why the // executable file might be covered by the GNU General Public License. -/// \file image2d.i +/// \file image2d_int_u8.i /// \brief A simple wrapping of mln::image2d<mln::value::int_u8> along /// with some algorithms. diff --git a/swilena/image2d_rgb8.i b/swilena/image2d_rgb8.i index bda1ff9..6b8b2d8 100644 --- a/swilena/image2d_rgb8.i +++ b/swilena/image2d_rgb8.i @@ -25,7 +25,7 @@ // exception does not however invalidate any other reasons why the // executable file might be covered by the GNU General Public License. -/// \file image2d.i +/// \file image2d_rgb8.i /// \brief A simple wrapping of mln::image2d<mln::value::rgb8> along /// with some algorithms. diff --git a/swilena/int_u.ixx b/swilena/int_u.ixx index b558467..a10b0de 100644 --- a/swilena/int_u.ixx +++ b/swilena/int_u.ixx @@ -1,5 +1,6 @@ // -*- C++ -*- -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -91,18 +92,21 @@ namespace mln - /*! \brief Print an unsigned integer \p i into the output stream \p ostr. - * - * \param[in,out] ostr An output stream. - * \param[in] i An unsigned integer. - * - * \return The modified output stream \p ostr. - */ + /// \brief Print an unsigned integer \p i on the output stream \p ostr. + /// + /// \param[in,out] ostr An output stream. + /// \param[in] i An unsigned integer. + /// + /// \return The modified output stream \p ostr. template <unsigned n> std::ostream& operator<<(std::ostream& ostr, const int_u<n>& i); - - // FIXME: Doc! + /// \brief Get an unsigned integer \p i from the input stream \p istr. + /// + /// \param[in,out] istr An input stream. + /// \param[out] i An unsigned integer (destination). + /// + /// \return The modified input stream \p istr. template <unsigned n> std::istream& operator>>(std::istream& istr, int_u<n>& i); diff --git a/swilena/python-utils.ixx b/swilena/python-utils.ixx index 6d18e4a..30160e9 100644 --- a/swilena/python-utils.ixx +++ b/swilena/python-utils.ixx @@ -1,5 +1,5 @@ // -*- C++ -*- -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -39,7 +39,6 @@ %define generate__str__(Type) %{ #include <cstring> -#include <string> #include <sstream> %} diff --git a/swilena/rgb.ixx b/swilena/rgb.ixx index c5607f3..bc9f6d3 100644 --- a/swilena/rgb.ixx +++ b/swilena/rgb.ixx @@ -126,17 +126,21 @@ namespace mln }; - /*! \brief Print an unsigned integer \p i into the output stream \p ostr. - * - * \param[in,out] ostr An output stream. - * \param[in] i An unsigned integer. - * - * \return The modified output stream \p ostr. - */ + /// Print an RGB \p c value on the output stream \p ostr. + /// + /// \param[in,out] ostr An output stream. + /// \param[in] c An RGB value. + /// + /// \return The modified output stream \p ostr. template <unsigned n> std::ostream& operator<<(std::ostream& ostr, const rgb<n>& i); - // FIXME: Doc! + /// Get an RGB value \p c from the input stream \p istr. + /// + /// \param[in,out] istr An input stream. + /// \param[out] c An RGB value (destination). + /// + /// \return The modified input stream \p istr. template <unsigned n> std::istream& operator>>(std::istream& istr, rgb<n>& i); -- 1.7.0.4