Index: olena/ChangeLog from Niels Van Vliet <niels@lrde.epita.fr> * olena/oln/arith/internal/opdecls.hh: Clean doc. * olena/oln/arith/ops.hh: Likewise. * olena/oln/convert/conversion.hh: Likewise. * olena/oln/convol/convolution.hh: Likewise. * olena/oln/convol/fast_gaussian.hh: Likewise. * olena/oln/convol/fast_gaussian.hxx: Likewise. * olena/oln/core/abstract/dpoint.hh: Likewise. * olena/oln/core/abstract/iter.hh: Likewise. * olena/oln/level/cc.hh: Likewise. * olena/oln/math/macros.hh: Likewise. * olena/oln/morpho/extrema.hh: Likewise. * olena/oln/morpho/extrema.hxx: Likewise. * olena/oln/morpho/fast_morpho.hxx: Likewise. * olena/oln/topo/dmap.hh: Likewise. * olena/oln/utils/histogram.hh: Likewise. * olena/oln/topo/tarjan/union.hh: Likewise. * olena/oln/topo/inter-pixel/internal/dir.hh: Likewise. * olena/oln/core/abstract/image.hh: Likewise. * olena/oln/core/impl/image_array.hh: Likewise. * olena/oln/convert/abstract/conversion.hh: Likewise. * olena/oln/snakes/snakes_base.hh: Likewise. * olena/oln/morpho/attributes.hh: Likewise. * olena/oln/morpho/attribute_closing_opening_map.hh: Likewise. Index: olena/oln/arith/internal/opdecls.hh --- olena/oln/arith/internal/opdecls.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/b/22_opdecls.hh 1.17 640) +++ olena/oln/arith/internal/opdecls.hh Mon, 15 Mar 2004 15:41:45 +0100 van-vl_n (oln/b/22_opdecls.hh 1.18 640) @@ -33,12 +33,10 @@ ** Operations are defined between two images and between one image and ** one constant value (with the cst suffix). ** The two main components are: -** \n -** 1) Define functors for each operations, taking two values and +** -# Define functors for each operations, taking two values and ** returning the result. -**\n -** 2) Define front-end functions applying a functor on the whole image. -** 3 versions are defined, leaving the possibility to specify the +** -# Define front-end functions applying a functor on the whole image. +** -# Versions are defined, leaving the possibility to specify the ** return type automatically, manually or using a conversion (from ** convert). ** Index: olena/oln/arith/ops.hh --- olena/oln/arith/ops.hh Sat, 13 Mar 2004 17:58:18 +0100 van-vl_n (oln/b/23_ops.hh 1.5.1.2.1.9 640) +++ olena/oln/arith/ops.hh Mon, 15 Mar 2004 16:12:16 +0100 van-vl_n (oln/b/23_ops.hh 1.5.1.2.1.10 640) @@ -39,7 +39,7 @@ namespace oln { /*! - ** \brief Namespace for arithmetic. + ** \brief Arithmetic implementation. */ namespace arith { Index: olena/oln/convert/conversion.hh --- olena/oln/convert/conversion.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/21_conversion 1.17 640) +++ olena/oln/convert/conversion.hh Mon, 15 Mar 2004 17:15:47 +0100 van-vl_n (oln/21_conversion 1.18 640) @@ -37,7 +37,8 @@ namespace oln { /*! - ** \brief Namespace for conversion (for example cast, color, or neighborhood to window). + ** \brief Conversion implementation (for example cast, color, or + ** neighborhood to window). */ namespace convert { @@ -56,7 +57,7 @@ typedef typename abstract::conversion<ConvType, Base>::template output<InputType>::ret ret; }; - /// namespace internal, should not be used by end user. + /// \brief Internal purpose only. namespace internal { /*! Compose a conversion C and an adaptable unary function UF, ** producing an adaptable unary function. Index: olena/oln/convol/convolution.hh --- olena/oln/convol/convolution.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/f/39_convolutio 1.4.1.4.1.6.1.2 640) +++ olena/oln/convol/convolution.hh Mon, 15 Mar 2004 16:51:22 +0100 van-vl_n (oln/f/39_convolutio 1.4.1.4.1.6.1.3 640) @@ -37,18 +37,11 @@ namespace oln { - /*! - ** \brief convolution namespace. - ** - ** Set of algorithms related to convolution. + /*! \brief Algorithms related to convolution. */ namespace convol { - /*! - ** \brief oln::convol::slow namespace. - ** - ** The algorithms you can find here are slow. This mean there are - ** only basic applications of the definitions. + /*! \brief Convolution algorithms. */ namespace slow { Index: olena/oln/convol/fast_gaussian.hh --- olena/oln/convol/fast_gaussian.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/26_fast_gauss 1.6.1.6.1.5 640) +++ olena/oln/convol/fast_gaussian.hh Mon, 15 Mar 2004 16:08:49 +0100 van-vl_n (oln/26_fast_gauss 1.6.1.6.1.6 640) @@ -41,10 +41,10 @@ namespace oln { namespace convol { /*! - ** \brief oln::convol::fast namespace. + ** \brief Implementation of algorithms for large structuring elements. ** ** The algorithms you can find here are fast. This mean these ones - ** are evolved versions. + ** are evolved versions for large structuring elements. */ namespace fast { Index: olena/oln/convol/fast_gaussian.hxx --- olena/oln/convol/fast_gaussian.hxx Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/25_fast_gauss 1.7.1.8.1.8 640) +++ olena/oln/convol/fast_gaussian.hxx Mon, 15 Mar 2004 17:30:37 +0100 van-vl_n (oln/25_fast_gauss 1.7.1.8.1.9 640) @@ -38,10 +38,7 @@ namespace oln { namespace convol { namespace fast { - /*! - ** \brief oln::convol::fast::internal namespace. - ** - ** You can find here function used for fast algorithms. + /*! \brief Internal purpose only. */ namespace internal { Index: olena/oln/core/abstract/dpoint.hh --- olena/oln/core/abstract/dpoint.hh Thu, 11 Mar 2004 17:12:19 +0100 thivol_d (oln/d/28_dpoint.hh 1.19 640) +++ olena/oln/core/abstract/dpoint.hh Mon, 15 Mar 2004 17:32:25 +0100 van-vl_n (oln/d/28_dpoint.hh 1.20 640) @@ -247,11 +247,8 @@ } // end of abstract - /*! \namespace oln::internal - ** \brief internal namespace. + /*! \brief Internal purpose only. */ - - namespace internal { Index: olena/oln/core/abstract/iter.hh --- olena/oln/core/abstract/iter.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/c/40_iter.hh 1.19 640) +++ olena/oln/core/abstract/iter.hh Mon, 15 Mar 2004 16:50:54 +0100 van-vl_n (oln/c/40_iter.hh 1.20 640) @@ -36,9 +36,7 @@ namespace oln { - /*! - ** \namespace oln::abstract - ** \brief oln::abstract namespace. + /*! \brief Abstract class implementation. */ namespace abstract { template<class Exact> @@ -136,7 +134,7 @@ ** \endcode ** ** You can iterate not only image but windows. This example make a binary - ** dilatation to show you how use them: + ** dilatation to show you how to use them: ** \code ** #include <oln/basics2d.hh> ** #include <ntg/all.hh> Index: olena/oln/level/cc.hh --- olena/oln/level/cc.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/e/20_cc.hh 1.11.1.13 640) +++ olena/oln/level/cc.hh Mon, 15 Mar 2004 16:54:36 +0100 van-vl_n (oln/e/20_cc.hh 1.11.1.14 640) @@ -49,8 +49,7 @@ # include <mlc/is_a.hh> namespace oln { - /*! \namespace oln::level - ** \brief level namespace. + /*! \brief Level algorithm implementation. */ namespace level { Index: olena/oln/math/macros.hh --- olena/oln/math/macros.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/b/21_macros.hh 1.6.1.13 640) +++ olena/oln/math/macros.hh Mon, 15 Mar 2004 16:55:15 +0100 van-vl_n (oln/b/21_macros.hh 1.6.1.14 640) @@ -33,7 +33,7 @@ namespace oln { - /*! Useful functions. + /*! \brief Useful functions. ** ** \todo FIXME: I'm not proud of the code below ** think it could be better... Index: olena/oln/morpho/extrema.hh --- olena/oln/morpho/extrema.hh Fri, 12 Mar 2004 13:29:59 +0100 palma_g (oln/38_extrema.hh 1.13 640) +++ olena/oln/morpho/extrema.hh Mon, 15 Mar 2004 16:56:53 +0100 van-vl_n (oln/38_extrema.hh 1.14 640) @@ -35,29 +35,19 @@ namespace oln { namespace morpho { - /*! - ** \brief oln::morpho::sure namespace. - ** - ** Namespace where you can find reference algorithms, i.e. those - ** that are sure. + /*! \brief Reference algorithm implementation: sure but slow. */ namespace sure { # include <oln/morpho/extrema.hxx> } - /*! - ** \brief oln::morpho::sequential namespace. - ** - ** Namespace where you can find sequential algorithms. + /*! \brief Sequential algorithm implementation. */ namespace sequential { # include <oln/morpho/extrema.hxx> } - /*! - ** \brief oln::morpho::hybrid namespace. - ** - ** Namespace where you can find hybrid algorithms. + /*! \brief Hybrid (sure and sequential) algorithm implementation. */ namespace hybrid { # include <oln/morpho/extrema.hxx> Index: olena/oln/morpho/extrema.hxx --- olena/oln/morpho/extrema.hxx Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/j/4_extrema.hx 1.15 640) +++ olena/oln/morpho/extrema.hxx Mon, 15 Mar 2004 16:28:44 +0100 van-vl_n (oln/j/4_extrema.hx 1.16 640) @@ -26,7 +26,7 @@ // Public License. /*! -** \brief internal namespace +** \brief Internal purpose only. */ namespace internal { Index: olena/oln/morpho/fast_morpho.hxx --- olena/oln/morpho/fast_morpho.hxx Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/45_fast_morph 1.20 640) +++ olena/oln/morpho/fast_morpho.hxx Mon, 15 Mar 2004 17:14:49 +0100 van-vl_n (oln/45_fast_morph 1.21 640) @@ -40,9 +40,7 @@ namespace oln { namespace morpho { - /*! - ** \brief oln::morpho::internal namespace - ** Internal stuff. + /*! \brief Internal purpose only. */ namespace internal { Index: olena/oln/topo/dmap.hh --- olena/oln/topo/dmap.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/p/2_dmap.hh 1.10 640) +++ olena/oln/topo/dmap.hh Mon, 15 Mar 2004 17:12:39 +0100 van-vl_n (oln/p/2_dmap.hh 1.11 640) @@ -44,7 +44,7 @@ namespace oln { - /// Namespce topo. + /// \brief Topological algorithms. namespace topo { /*! Chamfer mask. ** Index: olena/oln/utils/histogram.hh --- olena/oln/utils/histogram.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/10_histogram. 1.6.1.14.1.8 640) +++ olena/oln/utils/histogram.hh Mon, 15 Mar 2004 17:18:31 +0100 van-vl_n (oln/10_histogram. 1.6.1.14.1.9 640) @@ -39,10 +39,10 @@ # include <vector> namespace oln { - /// Namespace for utilities, such as statistic. + /// \brief Utilities, such as statistics. namespace utils { - /// Function within this namespace should not be used outside this file. + /// \brief Internal purpose only. namespace internal { //! Return the size of the space needed to explore the type T. template <typename T> @@ -83,7 +83,7 @@ }; } // end of namespace internal - /// Namespace for abstract utilities. + /// \brief Abstract utilities. namespace abstract { /*! Abstract base class for historgram. Index: olena/oln/morpho/attribute_closing_opening.hh --- olena/oln/morpho/attribute_closing_opening.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/q/49_attribute_ 1.21 640) +++ olena/oln/morpho/attribute_closing_opening.hh Mon, 15 Mar 2004 17:33:39 +0100 van-vl_n (oln/q/49_attribute_ 1.22 640) @@ -32,24 +32,16 @@ namespace oln { - /*! \namespace oln::morpho - ** \brief oln::morpho namespace + /*! \brief Algorithm based on morphological mathematic. */ namespace morpho { - /*! - ** \brief oln::morpho::fast namespace - ** - ** In this namespace, you will find fast algorithms, but with intensive memory usage + /*! \brief Algorithm enhanced for large structuring elements. */ namespace fast { - /*! - ** \brief oln::morpho::fast::tarjan namespace + /*! \brief oln::morpho::tarjan implementation. */ namespace tarjan { - /*! - ** \brief oln::morpho::fast::tarjan::internal namespace - ** - ** Internal usage only. + /*! \brief Internal purpose only. */ namespace internal { Index: olena/oln/topo/tarjan/union.hh --- olena/oln/topo/tarjan/union.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/r/33_union.hh 1.10 640) +++ olena/oln/topo/tarjan/union.hh Mon, 15 Mar 2004 16:59:55 +0100 van-vl_n (oln/r/33_union.hh 1.11 640) @@ -35,7 +35,7 @@ namespace oln { namespace topo { - /// Namespace Tarjan + /// \brief FIXME: depreciated, use oln::morpho::tarjan namespace tarjan { struct empty_class Index: olena/oln/topo/inter-pixel/node.hh --- olena/oln/topo/inter-pixel/node.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/r/46_node.hh 1.6 640) +++ olena/oln/topo/inter-pixel/node.hh Mon, 15 Mar 2004 16:37:40 +0100 van-vl_n (oln/r/46_node.hh 1.7 640) @@ -33,7 +33,7 @@ namespace oln { namespace topo { - /// Namespace for inter pixel, + /// oln::topo::inter_pixel::interpixel implementation. namespace inter_pixel { /*! Inter pixel node. ** Index: olena/oln/topo/inter-pixel/internal/dir.hh --- olena/oln/topo/inter-pixel/internal/dir.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/r/48_dir.hh 1.4 640) +++ olena/oln/topo/inter-pixel/internal/dir.hh Mon, 15 Mar 2004 17:15:24 +0100 van-vl_n (oln/r/48_dir.hh 1.5 640) @@ -37,7 +37,7 @@ namespace topo { namespace inter_pixel { - /// oln::topo::inter_pixel Internal namespace. + /// \brief Internal purpose only. namespace internal { /// Provides the enum dir. template<unsigned Dim> Index: olena/oln/core/abstract/image.hh --- olena/oln/core/abstract/image.hh Fri, 12 Mar 2004 20:17:58 +0100 thivol_d (oln/t/25_image.hh 1.25 640) +++ olena/oln/core/abstract/image.hh Mon, 15 Mar 2004 15:54:27 +0100 van-vl_n (oln/t/25_image.hh 1.26 600) @@ -37,10 +37,6 @@ namespace oln { - /*! \namespace abstract - ** \brief abstract namespace. - */ - namespace abstract { // fwd_decl Index: olena/oln/core/impl/image_array.hh --- olena/oln/core/impl/image_array.hh Fri, 12 Mar 2004 20:17:58 +0100 thivol_d (oln/t/30_image_arra 1.15 640) +++ olena/oln/core/impl/image_array.hh Mon, 15 Mar 2004 16:52:49 +0100 van-vl_n (oln/t/30_image_arra 1.16 600) @@ -82,11 +82,8 @@ }; - /*! \namespace impl - ** - ** \brief impl namespace. + /*! \brief Representation of the image in memory. */ - namespace impl { /*! \class image_array Index: olena/oln/convert/abstract/conversion.hh --- olena/oln/convert/abstract/conversion.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/u/31_conversion 1.5 640) +++ olena/oln/convert/abstract/conversion.hh Mon, 15 Mar 2004 16:52:04 +0100 van-vl_n (oln/u/31_conversion 1.6 640) @@ -35,7 +35,7 @@ namespace oln { namespace convert { /*! - ** \brief Namespace oln::convert::abstract. + ** \brief Base classes for conversion. */ namespace abstract { @@ -54,8 +54,7 @@ template<class Conv> struct conversion_traits; - /*! - ** Namespace oln::convert::abstract::internal, for internal usage only. + /*! \brief Internal purpose only. */ namespace internal { /// Retrieve the result type of a conversion. @@ -82,7 +81,7 @@ namespace abstract { /*! Base class for conversion. ** - ** \note If you write an class inherited from this one, you + ** \note If you write an class derived from this one, you ** must write the specialization of the output trait. */ template<class Exact, class Base> Index: olena/oln/snakes/snakes_base.hh --- olena/oln/snakes/snakes_base.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/f/50_snakes_bas 1.3 644) +++ olena/oln/snakes/snakes_base.hh Mon, 15 Mar 2004 17:20:34 +0100 van-vl_n (oln/f/50_snakes_bas 1.4 644) @@ -32,8 +32,7 @@ namespace oln { - /*! \namespace oln::snakes - ** Namespace snakes. + /*! \brief oln::snakes::snake implementation. */ namespace snakes { /*! Snake algorithm. Index: olena/oln/morpho/attributes.hh --- olena/oln/morpho/attributes.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/j/45_attributes 1.8 644) +++ olena/oln/morpho/attributes.hh Mon, 15 Mar 2004 16:58:28 +0100 van-vl_n (oln/j/45_attributes 1.9 644) @@ -48,8 +48,7 @@ namespace oln { namespace morpho { - /*! - ** \brief oln::morpho::tools namespace + /*! \brief Useful tools for morphological math. */ namespace tools { Index: olena/oln/morpho/attribute_closing_opening_map.hh --- olena/oln/morpho/attribute_closing_opening_map.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/j/49_attribute_ 1.7 600) +++ olena/oln/morpho/attribute_closing_opening_map.hh Mon, 15 Mar 2004 16:57:32 +0100 van-vl_n (oln/j/49_attribute_ 1.8 600) @@ -46,11 +46,8 @@ { namespace morpho { - /*! - ** \brief oln::morpho::slow namespace - ** - ** In this namespace you will find algorithm slower than those you - ** can find in oln::morpho::fast, but with less memory needs. + /*! \brief Algorithm that are slow (but need less memory), or that are slow + ** if it is used with a large structuring element. */ namespace slow {