[Olena-patches] oln: 10.101: Correct comments.

Index: olena/ChangeLog from Simon Odou &lt;simon(a)lrde.epita.fr&gt; * olena/oln/core/bkd_iter1d.hh: Correct comments. * olena/oln/core/bkd_iter2d.hh: Likewise. * olena/oln/core/bkd_iter3d.hh: Likewise. * olena/oln/core/fwd_iter1d.hh: Likewise. * olena/oln/core/fwd_iter2d.hh: Likewise. * olena/oln/core/fwd_iter3d.hh: Likewise. * olena/oln/core/abstract/iter1d.hh: Likewise. * olena/oln/core/abstract/iter2d.hh: Likewise. * olena/oln/core/abstract/iter3d.hh: Likewise. * olena/oln/core/abstract/iter.hh: Likewise. * olena/oln/core/neighborhood1d.hh: Likewise. * olena/oln/core/neighborhood2d.hh: Likewise. * olena/oln/core/neighborhood3d.hh: Likewise. * olena/oln/core/abstract/neighborhood.hh: Likewise. * olena/oln/core/abstract/struct_elt.hh: Likewise. * olena/oln/core/window1d.hh: Likewise. * olena/oln/core/window2d.hh: Likewise. * olena/oln/core/window3d.hh: Likewise. * olena/oln/core/abstract/window.hh: Likewise. * olena/oln/core/w_window1d.hh: Likewise. * olena/oln/core/w_window2d.hh: Likewise. * olena/oln/core/w_window3d.hh: Likewise. * olena/oln/core/abstract/w_window.hh: Likewise. * olena/oln/io/base.hh: Likewise. * olena/oln/core/abstract/window_base.hh: Likewise. * olena/oln/core/abstract/windownd.hh: Likewise. * olena/oln/core/abstract/w_windownd.hh: Likewise. * olena/oln/core/abstract/neighborhoodnd.hh: Likewise. Index: olena/oln/core/bkd_iter1d.hh --- olena/oln/core/bkd_iter1d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/38_bkd_iter1d 1.18 640) +++ olena/oln/core/bkd_iter1d.hh Fri, 19 Mar 2004 13:41:07 +0100 odou_s (oln/d/38_bkd_iter1d 1.18 640) @@ -99,12 +99,7 @@ return super_iter_type::operator=(u); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/bkd_iter2d.hh --- olena/oln/core/bkd_iter2d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/37_bkd_iter2d 1.18 640) +++ olena/oln/core/bkd_iter2d.hh Fri, 19 Mar 2004 13:41:22 +0100 odou_s (oln/d/37_bkd_iter2d 1.18 640) @@ -98,12 +98,7 @@ return super_iter_type::operator=(u); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/bkd_iter3d.hh --- olena/oln/core/bkd_iter3d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/36_bkd_iter3d 1.18 640) +++ olena/oln/core/bkd_iter3d.hh Fri, 19 Mar 2004 13:41:45 +0100 odou_s (oln/d/36_bkd_iter3d 1.18 640) @@ -95,12 +95,7 @@ return super_iter_type::operator=(u); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { return std::string("bkd_iter3d<") + Exact::name() + ">"; Index: olena/oln/core/fwd_iter1d.hh --- olena/oln/core/fwd_iter1d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/21_fwd_iter1d 1.15 640) +++ olena/oln/core/fwd_iter1d.hh Fri, 19 Mar 2004 13:42:07 +0100 odou_s (oln/d/21_fwd_iter1d 1.15 640) @@ -97,12 +97,7 @@ return super_iter_type::operator=(u); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/fwd_iter2d.hh --- olena/oln/core/fwd_iter2d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/20_fwd_iter2d 1.15 640) +++ olena/oln/core/fwd_iter2d.hh Fri, 19 Mar 2004 13:45:33 +0100 odou_s (oln/d/20_fwd_iter2d 1.15 640) @@ -99,12 +99,7 @@ return super_iter_type::operator=(u); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/fwd_iter3d.hh --- olena/oln/core/fwd_iter3d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/19_fwd_iter3d 1.15 640) +++ olena/oln/core/fwd_iter3d.hh Fri, 19 Mar 2004 13:45:32 +0100 odou_s (oln/d/19_fwd_iter3d 1.15 640) @@ -96,12 +96,7 @@ return super_iter_type::operator=(u); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/iter1d.hh --- olena/oln/core/abstract/iter1d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/10_iter1d.hh 1.19 640) +++ olena/oln/core/abstract/iter1d.hh Fri, 19 Mar 2004 13:45:36 +0100 odou_s (oln/d/10_iter1d.hh 1.19 640) @@ -88,12 +88,7 @@ return this->p_.col(); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { return std::string("_iter1d<") + Exact::name() + ">"; Index: olena/oln/core/abstract/iter2d.hh --- olena/oln/core/abstract/iter2d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/9_iter2d.hh 1.19 640) +++ olena/oln/core/abstract/iter2d.hh Fri, 19 Mar 2004 13:45:35 +0100 odou_s (oln/d/9_iter2d.hh 1.19 640) @@ -101,12 +101,7 @@ return this->p_.col(); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { return std::string("_iter2d<") + Exact::name() + ">"; Index: olena/oln/core/abstract/iter3d.hh --- olena/oln/core/abstract/iter3d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/d/8_iter3d.hh 1.19 640) +++ olena/oln/core/abstract/iter3d.hh Fri, 19 Mar 2004 13:45:35 +0100 odou_s (oln/d/8_iter3d.hh 1.19 640) @@ -114,12 +114,7 @@ return this->p_.col(); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { return std::string("_iter3d<") + Exact::name() + ">"; Index: olena/oln/core/abstract/iter.hh --- olena/oln/core/abstract/iter.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/40_iter.hh 1.21 640) +++ olena/oln/core/abstract/iter.hh Fri, 19 Mar 2004 13:45:36 +0100 odou_s (oln/c/40_iter.hh 1.21 640) @@ -358,12 +358,7 @@ return ! this->operator==(e); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/neighborhood1d.hh --- olena/oln/core/neighborhood1d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/37_neighborho 1.17 640) +++ olena/oln/core/neighborhood1d.hh Fri, 19 Mar 2004 13:46:58 +0100 odou_s (oln/c/37_neighborho 1.17 640) @@ -58,7 +58,7 @@ ** ** It looks like structuring elements but here, when ** you add an element, you add its opposite. - ** Points have 1 dimensions. + ** Points (dpoint) have 1 dimension. ** */ class neighborhood1d : @@ -139,12 +139,7 @@ add(dpoint_type(crd[i])); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/neighborhood2d.hh --- olena/oln/core/neighborhood2d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/36_neighborho 1.18 640) +++ olena/oln/core/neighborhood2d.hh Fri, 19 Mar 2004 13:43:01 +0100 odou_s (oln/c/36_neighborho 1.18 640) @@ -159,12 +159,7 @@ return r.assign(*this); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/neighborhood3d.hh --- olena/oln/core/neighborhood3d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/35_neighborho 1.17 640) +++ olena/oln/core/neighborhood3d.hh Fri, 19 Mar 2004 13:43:18 +0100 odou_s (oln/c/35_neighborho 1.17 640) @@ -140,12 +140,7 @@ add(dpoint_type(crd[i], crd[i+1], crd[i+2])); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/neighborhood.hh --- olena/oln/core/abstract/neighborhood.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/38_neighborho 1.21 640) +++ olena/oln/core/abstract/neighborhood.hh Fri, 19 Mar 2004 16:01:20 +0100 odou_s (oln/c/38_neighborho 1.21 640) @@ -56,8 +56,7 @@ ** \brief Neighborhood. ** ** It looks like structuring elements but here, when - ** you add an element, you add its opposite (cf mathematical - ** definition to know more about). + ** you add an element, you add its opposite. ** This abstract class defines several virtual methods for his ** subclasses. Its goal is to deal with a set of deplacement points. ** @@ -93,12 +92,7 @@ enum { dim = struct_elt_traits<Exact>::dim }; ///< Set the dim of the points of the neighborhood. - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/struct_elt.hh --- olena/oln/core/abstract/struct_elt.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/25_structelt. 1.22 640) +++ olena/oln/core/abstract/struct_elt.hh Fri, 19 Mar 2004 16:01:45 +0100 odou_s (oln/c/25_structelt. 1.22 640) @@ -56,7 +56,7 @@ namespace abstract { /*! - ** Structuring elements (set of points). + ** Structuring elements (set of dpoints). ** ** This abstract class defines several virtual methods for its ** subclasses. Its goal is to deal with a set of 'move' points. @@ -72,12 +72,7 @@ typedef typename struct_elt_traits<Exact>::abstract_type abstract_type; ///< Set the abstract type of hisself. - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/window1d.hh --- olena/oln/core/window1d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/15_window1d.h 1.17 640) +++ olena/oln/core/window1d.hh Fri, 19 Mar 2004 13:45:31 +0100 odou_s (oln/c/15_window1d.h 1.17 640) @@ -139,12 +139,7 @@ add(dpoint_type(crd[i])); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/window2d.hh --- olena/oln/core/window2d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/14_window2d.h 1.19 640) +++ olena/oln/core/window2d.hh Fri, 19 Mar 2004 13:44:00 +0100 odou_s (oln/c/14_window2d.h 1.19 640) @@ -160,12 +160,7 @@ return r.assign(*this); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/window3d.hh --- olena/oln/core/window3d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/13_window3d.h 1.18 640) +++ olena/oln/core/window3d.hh Fri, 19 Mar 2004 13:44:21 +0100 odou_s (oln/c/13_window3d.h 1.18 640) @@ -139,12 +139,7 @@ add(dpoint_type(crd[i], crd[i+1], crd[i+2])); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/window.hh --- olena/oln/core/abstract/window.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/16_window.hh 1.19 640) +++ olena/oln/core/abstract/window.hh Fri, 19 Mar 2004 13:45:34 +0100 odou_s (oln/c/16_window.hh 1.19 640) @@ -73,12 +73,7 @@ friend class struct_elt<exact_type>; - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/w_window1d.hh --- olena/oln/core/w_window1d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/19_w_window1d 1.18 640) +++ olena/oln/core/w_window1d.hh Fri, 19 Mar 2004 13:45:31 +0100 odou_s (oln/c/19_w_window1d 1.18 640) @@ -163,12 +163,7 @@ return set(dpoint_type(col), weight); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/w_window2d.hh --- olena/oln/core/w_window2d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/18_w_window2d 1.6.1.13 640) +++ olena/oln/core/w_window2d.hh Fri, 19 Mar 2004 13:45:31 +0100 odou_s (oln/c/18_w_window2d 1.6.1.13 640) @@ -182,12 +182,7 @@ return set(dpoint_type(row, col), weight); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/w_window3d.hh --- olena/oln/core/w_window3d.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/17_w_window3d 1.18 640) +++ olena/oln/core/w_window3d.hh Fri, 19 Mar 2004 13:45:16 +0100 odou_s (oln/c/17_w_window3d 1.18 640) @@ -169,12 +169,7 @@ return set(dpoint_type(slice, row, col), weight); } - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/w_window.hh --- olena/oln/core/abstract/w_window.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/c/20_w_window.h 1.16 640) +++ olena/oln/core/abstract/w_window.hh Fri, 19 Mar 2004 13:38:37 +0100 odou_s (oln/c/20_w_window.h 1.16 640) @@ -75,12 +75,7 @@ ///< Set the type of weight. friend class struct_elt<exact_type>; - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/io/base.hh --- olena/oln/io/base.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/b/20_base.hh 1.9 640) +++ olena/oln/io/base.hh Fri, 19 Mar 2004 16:25:55 +0100 odou_s (oln/b/20_base.hh 1.9 640) @@ -47,9 +47,9 @@ namespace internal { /*! - ** \brief Read anything from a file. + ** \brief Read from a file. ** - ** The "good" read function is called by template specialization. + ** The specialized read function is called by template specialization. */ template<typename T> bool @@ -61,7 +61,7 @@ /*! ** \brief Write anything to a file. ** - ** The "good" write function is called by template specialization. + ** The specialized write function is called by template specialization. */ template<typename T> bool @@ -79,10 +79,13 @@ ** a window or a neighborhood. ** \arg name The name of the file. ** \return The new object. + ** \sa oln::abstract::iter ** - ** Here is the external interface. - ** If you would like some examples to know how to use that, go to - ** oln::abstract::iter + ** Call abstract::image::has_impl to test that your image has been + ** successfully loaded. + ** See oln::io::internal::reader_id to know which file are supported. + ** \sa abstract::image::has_impl + ** \sa */ inline internal::anything @@ -92,13 +95,12 @@ } /* - ** \brief Load object from a file. This could be an image but also - ** a window or a neighborhood. + ** \brief Load an image or a structuring element from a file. ** \arg output The object to write to a file. ** \arg name The name of the file. ** \return True if successful. ** - ** Here is the external interface. Depending of T, work is dispatched. + ** Depending of T, work is dispatched. */ template<class T> bool @@ -108,15 +110,14 @@ } /* - ** \brief Writing object to a file. This could be an image but also + ** \brief Write an image or a structuring element to a file. ** a window or a neighborhood. ** \arg input The object to read. ** \arg name The name of the file. ** \return True if successful. ** - ** Here is the external interface. Depending of T, work is dispatched. - ** If you would like some examples to know how to use that, go to - ** oln::abstract::iter + ** Depending of T, work is dispatched. + ** \sa oln::abstract::iter */ template< typename T > bool Index: olena/oln/core/abstract/window_base.hh --- olena/oln/core/abstract/window_base.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/u/3_window_bas 1.11 640) +++ olena/oln/core/abstract/window_base.hh Fri, 19 Mar 2004 13:45:34 +0100 odou_s (oln/u/3_window_bas 1.11 640) @@ -134,12 +134,7 @@ friend class neighborhood<Exact>; // friend class window_base_friend_traits<Sup>::ret; - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/windownd.hh --- olena/oln/core/abstract/windownd.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/u/4_windownd.h 1.9 640) +++ olena/oln/core/abstract/windownd.hh Fri, 19 Mar 2004 13:45:33 +0100 odou_s (oln/u/4_windownd.h 1.9 640) @@ -72,12 +72,7 @@ friend class window<exact_type>; - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/w_windownd.hh --- olena/oln/core/abstract/w_windownd.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/u/5_w_windownd 1.8 640) +++ olena/oln/core/abstract/w_windownd.hh Fri, 19 Mar 2004 13:39:47 +0100 odou_s (oln/u/5_w_windownd 1.8 640) @@ -74,12 +74,7 @@ friend class w_window<exact_type>; - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { Index: olena/oln/core/abstract/neighborhoodnd.hh --- olena/oln/core/abstract/neighborhoodnd.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/u/6_neighborho 1.8 640) +++ olena/oln/core/abstract/neighborhoodnd.hh Fri, 19 Mar 2004 17:35:10 +0100 odou_s (oln/u/6_neighborho 1.8 640) @@ -53,7 +53,9 @@ ** \brief Neighborhood N dimensions. ** ** It looks like structuring elements but here, when - ** you add an element, you add its opposite. + ** you add an element, you add its opposite: + ** \f$$\forall d \in N, -d \in N$\f$ + ** ** Points have N dimensions. ** */ @@ -74,12 +76,7 @@ friend class neighborhood<exact_type>; - /*! - ** \brief Return its type in a string. - ** \return The type in a string. - ** - ** Very useful to debug. - */ + ///< Return the name of the type. static std::string name() { -- Simon Odou simon(a)lrde.epita.fr