[Olena] oln 10.86: doc (Corrections)

Please, try to correct apply.hh and traverse.hh. There is many problems with \param and with \ref. There is mamy English problems too, such as the wrong usage of "we". Index: olena/ChangeLog from Niels Van Vliet &lt;niels(a)lrde.epita.fr&gt; * olena/oln/convert/nrgbxyz.hh: Correct comments. * olena/oln/convert/stretch.hh: Likewise. * olena/oln/level/cc.hh: Likewise. * olena/oln/morpho/gradient.inc: Likewise. * olena/oln/morpho/attribute_closing_opening.hh: Likewise. * olena/oln/morpho/attribute_union_find.hh: Likewise. * olena/oln/topo/inter-pixel/inter-pixel.hh: Likewise. * olena/oln/topo/inter-pixel/node.hh: Likewise. * olena/oln/core/abstract/image_with_dim.hh: Likewise. * olena/oln/core/impl/image_impl.hh: Likewise. * olena/oln/morpho/attributes.hh: Likewise. * olena/oln/utils/special_points.hh: Likewise. Index: olena/oln/convert/nrgbxyz.hh --- olena/oln/convert/nrgbxyz.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/16_nrgbxyz.hh 1.13 640) +++ olena/oln/convert/nrgbxyz.hh Sun, 14 Mar 2004 18:40:08 +0100 van-vl_n (oln/16_nrgbxyz.hh 1.13 640) @@ -52,7 +52,7 @@ /*! Functor for conversion from N-RGB to XYZ color space. ** - ** \obsolete A composition should be performed with nrgb->rgb and rgb->xyz. It has + ** \deprecated A composition should be performed with nrgb->rgb and rgb->xyz. It has ** not been replaced within the function because a double conversion 'reduces' ** the color space. See the following example: ** \code @@ -112,7 +112,7 @@ /*! Conversion from N-RGB to XYZ color space. ** - ** \obsolete A composition should be performed with nrgb->rgb and rgb->xyz. + ** \deprecated A composition should be performed with nrgb->rgb and rgb->xyz. ** ** \see f_nrgb_to_xyz for more information. */ @@ -127,7 +127,7 @@ /*! Functor for conversion from XYZ to N-RGB color space. ** - ** \obsolete A composition should be performed with xyz->rgb and rgb->nrgb. + ** \deprecated A composition should be performed with xyz->rgb and rgb->nrgb. ** ** \see f_nrgb_to_xyz for more information. */ @@ -162,7 +162,7 @@ /*! Conversion from XYZ to N-RGB color space. ** - ** \obsolete a composition should be performed with xyz->rgb and rgb->nrgb. + ** \deprecated a composition should be performed with xyz->rgb and rgb->nrgb. ** ** \see f_nrgb_to_xyz for more information. */ Index: olena/oln/convert/stretch.hh --- olena/oln/convert/stretch.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/f/51_stretch.hh 1.16 640) +++ olena/oln/convert/stretch.hh Sun, 14 Mar 2004 18:46:17 +0100 van-vl_n (oln/f/51_stretch.hh 1.16 640) @@ -92,7 +92,7 @@ /*! Stretch the value of an image. ** ** This function stretches values between \a min_in and \a max_in - ** of an image \in, to a range that goes from \a min_out to \a max_out. + ** of an image \a in, to a range that goes from \a min_out to \a max_out. ** \arg in Input image, must be have scalar values ** \arg min_in Lower bound of the range in the input. All values smaller ** than min_in are converted to \a min_out. Index: olena/oln/level/cc.hh --- olena/oln/level/cc.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/e/20_cc.hh 1.11.1.11 640) +++ olena/oln/level/cc.hh Sun, 14 Mar 2004 18:47:51 +0100 van-vl_n (oln/e/20_cc.hh 1.11.1.11 640) @@ -61,7 +61,7 @@ ** the connected components. ** ** It removes the small (in area) connected components of the upper - ** level sets of \var{input} using \var{se} as structural element. + ** level sets of \a input using \a se as structural element. ** ** \ref The implementation uses front propagation. ** Index: olena/oln/morpho/gradient.inc --- olena/oln/morpho/gradient.inc Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/43_gradient.i 1.15 640) +++ olena/oln/morpho/gradient.inc Sun, 14 Mar 2004 18:51:26 +0100 van-vl_n (oln/43_gradient.i 1.15 640) @@ -201,7 +201,7 @@ ** IMG_OUT "oln_morpho_external_gradient.pbm"); ** return 0; ** } -** \encode +** \endcode ** ** \image html lena256_pgm.png ** \image latex lena256_pgm.png Index: olena/oln/morpho/attribute_closing_opening.hh --- olena/oln/morpho/attribute_closing_opening.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/q/49_attribute_ 1.20 640) +++ olena/oln/morpho/attribute_closing_opening.hh Sun, 14 Mar 2004 18:52:18 +0100 van-vl_n (oln/q/49_attribute_ 1.20 640) @@ -30,9 +30,7 @@ #include <oln/morpho/attribute_union_find.hh> -/*! \namespace oln -** \brief oln namespace -*/ + namespace oln { /*! \namespace oln::morpho ** \brief oln::morpho namespace Index: olena/oln/morpho/attribute_union_find.hh --- olena/oln/morpho/attribute_union_find.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/q/50_attribute_ 1.16 640) +++ olena/oln/morpho/attribute_union_find.hh Sun, 14 Mar 2004 18:42:36 +0100 van-vl_n (oln/q/50_attribute_ 1.16 640) @@ -49,7 +49,7 @@ ** \param ATTRIBUTE Exact type of attribute to use. ** \param Env Type of environment to use. ** - ** \Note FIXME: a similar class is defined in oln/topo/tarjan/union.hh + ** \note FIXME: a similar class is defined in oln/topo/tarjan/union.hh ** (oln::topo::tarjan::tarjan_set). */ template<class T, class ATTRIBUTE, class Env = attr_env_type(ATTRIBUTE)> Index: olena/oln/topo/inter-pixel/inter-pixel.hh --- olena/oln/topo/inter-pixel/inter-pixel.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/r/34_inter-pixe 1.13 640) +++ olena/oln/topo/inter-pixel/inter-pixel.hh Sun, 14 Mar 2004 18:27:59 +0100 van-vl_n (oln/r/34_inter-pixe 1.13 640) @@ -68,6 +68,7 @@ ** // (10,11): north west south ** // (11,14): north west south ** } + ** \endcode ** \todo FIXME: Test the output values in the tests. */ template <class I> Index: olena/oln/topo/inter-pixel/node.hh --- olena/oln/topo/inter-pixel/node.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/r/46_node.hh 1.5 640) +++ olena/oln/topo/inter-pixel/node.hh Sun, 14 Mar 2004 18:43:28 +0100 van-vl_n (oln/r/46_node.hh 1.5 640) @@ -67,7 +67,7 @@ data_[i] = true; } - /// Return true if the direction \i joins the node. + /// Return true if the direction \a i joins the node. bool get(dir_type i) const { Index: olena/oln/core/abstract/image_with_dim.hh --- olena/oln/core/abstract/image_with_dim.hh Thu, 11 Mar 2004 20:19:51 +0100 thivol_d (oln/t/26_image_with 1.20 600) +++ olena/oln/core/abstract/image_with_dim.hh Sun, 14 Mar 2004 18:30:27 +0100 van-vl_n (oln/t/26_image_with 1.20 600) @@ -151,11 +151,7 @@ namespace abstract { - /*! \class image_with_dim<1, Exact>: virtual public image<Exact> - ** - ** The specialized version for image1d. - */ - + /// The specialized version for image1d. template <class Exact> class image_with_dim<1, Exact>: virtual public image<Exact> { @@ -280,12 +276,7 @@ - /*! \class image_with_dim<2, Exact>: virtual public image<Exact> - ** - ** The specialized version for image2d. - */ - - + /// The specialized version for image2d. template <class Exact> class image_with_dim<2, Exact>: virtual public image<Exact> { @@ -423,10 +414,7 @@ }; // end of bi-dimensional specialization - /*! \class image_with_dim<3, Exact>: virtual public image<Exact> - ** - ** The specialized version for image3d. - */ + /// The specialized version for image3d. template <class Exact> class image_with_dim<3, Exact>: virtual public image<Exact> Index: olena/oln/core/impl/image_impl.hh --- olena/oln/core/impl/image_impl.hh Fri, 12 Mar 2004 20:17:58 +0100 thivol_d (oln/t/29_image_impl 1.17 640) +++ olena/oln/core/impl/image_impl.hh Sun, 14 Mar 2004 18:41:06 +0100 van-vl_n (oln/t/29_image_impl 1.17 640) @@ -111,7 +111,7 @@ return this->exact().at_(p); } - /// Return a reference to the value stored at \p. + /// Return a reference to the value stored at \a p. value_type& at(const point_type& p) Index: olena/oln/morpho/attributes.hh --- olena/oln/morpho/attributes.hh Fri, 12 Mar 2004 13:29:59 +0100 palma_g (oln/j/45_attributes 1.7 644) +++ olena/oln/morpho/attributes.hh Sun, 14 Mar 2004 18:26:35 +0100 van-vl_n (oln/j/45_attributes 1.7 644) @@ -183,9 +183,9 @@ }; /*! - ** \brief < operator + ** \brief "<" operator ** - ** This is a static dispatcher for the < operator. + ** This is a static dispatcher for the "<" operator. ** This method is abstract. */ bool operator<(const lambda_type &lambda) const @@ -282,9 +282,9 @@ }; /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** - ** This is an implementation of the < operator. Override this + ** This is an implementation of the "<" operator. Override this ** method to provide a new implementation of this operator. ** \warning This method SHOULDN'T be called. */ @@ -443,7 +443,7 @@ }; /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. @@ -693,7 +693,7 @@ }; /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. @@ -811,7 +811,7 @@ }; /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. @@ -927,7 +927,7 @@ }; /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. @@ -1088,7 +1088,7 @@ }; /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. @@ -1239,7 +1239,7 @@ }; /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. @@ -1408,7 +1408,7 @@ } /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. @@ -1567,7 +1567,7 @@ } /*! - ** \brief < operator implementation. + ** \brief "<" operator implementation. ** ** This is an implementation of the += operator. Override this ** method to provide a new implementation of this operator. Index: olena/oln/utils/special_points.hh --- olena/oln/utils/special_points.hh Sat, 13 Mar 2004 21:28:08 +0100 van-vl_n (oln/j/50_special_po 1.2 644) +++ olena/oln/utils/special_points.hh Sun, 14 Mar 2004 18:28:50 +0100 van-vl_n (oln/j/50_special_po 1.2 644) @@ -33,7 +33,7 @@ namespace oln { namespace utils { - /// oln::utils::internal + namespace internal { /*! Creates a point that is used as a state. *