[Olena-patches] oln 10.97: Doc correction.

Index: olena/ChangeLog from Giovanni Palma &lt;giovanni(a)lrde.epita.fr&gt; * oln/convol/fast_gaussian.hh: Correct comments. * oln/io/se_window.hh: Likewise. * oln/transforms/dwt.hh: Likewise. * oln/transforms/fft.hh: Likewise. Index: olena/oln/convol/fast_gaussian.hh --- olena/oln/convol/fast_gaussian.hh Mon, 15 Mar 2004 17:40:54 +0100 van-vl_n (oln/26_fast_gauss 1.6.1.6.1.6 640) +++ olena/oln/convol/fast_gaussian.hh Wed, 17 Mar 2004 11:35:39 +0100 palma_g (oln/26_fast_gauss 1.6.1.6.1.6 640) @@ -32,11 +32,12 @@ # include <oln/convert/basics.hh> # include <ntg/float.hh> # include <oln/core/behavior.hh> -// -// Gaussian filter implementation from -// "Recursively implementing the gaussian and its derivatives" -// Deriche 93 INRIA REPORT -// +/*! +** \file olena/oln/convol/fast_gaussian.hh +** Gaussian filter implementation from +** "Recursively implementing the gaussian and its derivatives" +** Deriche 93 INRIA REPORT. +*/ namespace oln { namespace convol { @@ -122,7 +123,7 @@ /* Same functions, with a default conversion. */ - /* + /*! ** \brief Gaussian filter with a default conversion. ** ** Gaussian filter implementation from "Recursively implementing Index: olena/oln/io/se_window.hh --- olena/oln/io/se_window.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/i/46_se_window. 1.15 640) +++ olena/oln/io/se_window.hh Tue, 16 Mar 2004 12:38:47 +0100 palma_g (oln/i/46_se_window. 1.15 640) @@ -46,7 +46,7 @@ namespace internal { - ///< \todo FIXME: this code should be factorized. + /// \todo FIXME: this code should be factorized. /*! ** \brief Read a window (1 dimension) from a file. Index: olena/oln/transforms/dwt.hh --- olena/oln/transforms/dwt.hh Tue, 16 Mar 2004 12:11:53 +0100 palma_g (oln/i/35_dwt.hh 1.2.1.4.1.11 640) +++ olena/oln/transforms/dwt.hh Tue, 16 Mar 2004 15:24:31 +0100 palma_g (oln/i/35_dwt.hh 1.2.1.4.1.11 640) @@ -95,15 +95,15 @@ public: // accessors - /// \brief Accessor to ith element of g. + /// Accessor to ith element of g. const value_t getG(unsigned i) const { return g[i]; } - /// \brief Accessor to ith element of ig. + /// Accessor to ith element of ig. const value_t getInvG(unsigned i) const { return ig[i]; } - /// \brief Accessor to ith element of h. + /// Accessor to ith element of h. const value_t getH(unsigned i) const { return h[i]; } - /// \brief Accessor to ith element of ih. + /// Accessor to ith element of ih. const value_t getInvH(unsigned i) const { return ih[i]; } - /// \brief Give the size of the arrays. + /// Give the size of the arrays. const unsigned size() const { return size_; } protected: @@ -139,14 +139,14 @@ mlc::is_false<N % 2>::ensure(); } - mlc::array1d< mlc::array1d_info<N>, value_t> h; /// \brief array of value_t. - mlc::internal::array1d_start_<value_t> wc_start; /// \brief First coefficient. + mlc::array1d< mlc::array1d_info<N>, value_t> h; ///< array of value_t. + mlc::internal::array1d_start_<value_t> wc_start; ///< First coefficient. private: - value_t g[N]; /// \brief array of value_t. - value_t ih[N]; /// \brief array of value_t. - value_t ig[N]; /// \brief array of value_t. + value_t g[N]; ///< Array of value_t. + value_t ih[N]; ///< Array of value_t. + value_t ig[N]; /// Array of value_t. enum { size_ = N }; @@ -474,10 +474,10 @@ { public: - typedef I original_im_t; ///< \brief Exact of the image. - typedef oln_value_type(I) original_im_value_t; ///< \brief Original data type of the image. - typedef typename mute<I, ntg::float_d>::ret trans_im_t; ///< \brief Type of the transformed image. - typedef typename K::self_t coeffs_t; ///< \brief Data type of coefficients. + typedef I original_im_t; ///< Exact of the image. + typedef oln_value_type(I) original_im_value_t; ///< Original data type of the image. + typedef typename mute<I, ntg::float_d>::ret trans_im_t; ///< Type of the transformed image. + typedef typename K::self_t coeffs_t; ///< Data type of coefficients. /*! ** \brief Constructor from an image. Index: olena/oln/transforms/fft.hh --- olena/oln/transforms/fft.hh Tue, 16 Mar 2004 12:11:53 +0100 palma_g (oln/i/36_fft.hh 1.4.1.9 640) +++ olena/oln/transforms/fft.hh Tue, 16 Mar 2004 15:25:00 +0100 palma_g (oln/i/36_fft.hh 1.4.1.9 640) @@ -46,7 +46,7 @@ namespace internal { - /// \brief dispatch traits for fftw + /// Dispatch traits for fftw enum fft_dispatch { fft_cplx, fft_real }; /*! -- Giovanni Palma EPITA - promo 2005 - membre d'EpX - LRDE Mob. : +33 (0)6 60 97 31 74