[Olena-patches] milena r1351: Fix namespace documentation

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena ChangeLog: 2007-10-17 Matthieu Garrigues &lt;garrigues(a)lrde.epita.fr&gt; Fix namespace documentation. * mln/geom/all.hh: New, * mln/histo/all.hh: New, * mln/labeling/all.hh: New, * mln/norm/all.hh: New, * mln/logical/all.hh: New, * mln/make/all.hh: New, add missing all.hh. * mln/core/concept/object.hh, * mln/core/grids.hh, * mln/math/all.hh, * mln/metal/all.hh, * mln/metal/math/all.hh, * mln/util/pix.hh: Update. --- core/concept/object.hh | 9 +++++ core/grids.hh | 3 - geom/all.hh | 61 +++++++++++++++++++++++++++++++++++++++ histo/all.hh | 52 +++++++++++++++++++++++++++++++++ labeling/all.hh | 58 +++++++++++++++++++++++++++++++++++++ logical/all.hh | 55 +++++++++++++++++++++++++++++++++++ make/all.hh | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ math/all.hh | 3 - metal/all.hh | 7 +++- metal/math/all.hh | 6 +++ norm/all.hh | 49 ++++++++++++++++++++++++++++++++ util/pix.hh | 1 12 files changed, 373 insertions(+), 6 deletions(-) Index: trunk/milena/mln/histo/all.hh =================================================================== --- trunk/milena/mln/histo/all.hh (revision 0) +++ trunk/milena/mln/histo/all.hh (revision 1351) @@ -0,0 +1,52 @@ +// Copyright (C) 2007 EPITA Research and Development Laboratory +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to +// produce an executable, this file does not by itself cause the +// resulting executable to be covered by the GNU General Public +// License. This exception does not however invalidate any other +// reasons why the executable file might be covered by the GNU General +// Public License. + +#ifndef MLN_HISTO_ALL_HH +# define MLN_HISTO_ALL_HH + +/*! \file mln/histo/all.hh + * + * \brief File that includes histogram files. + */ + + +namespace mln +{ + + /// Namespace of histograms. + namespace histo + { + /// Implementation namespace of histo namespace. + namespace impl {} + } + +} + +# include <mln/histo/compute.hh> +# include <mln/histo/data.hh> + +#endif // ! MLN_HISTO_ALL_HH Index: trunk/milena/mln/core/concept/object.hh =================================================================== --- trunk/milena/mln/core/concept/object.hh (revision 1350) +++ trunk/milena/mln/core/concept/object.hh (revision 1351) @@ -60,6 +60,15 @@ */ namespace mln { + /// Implementation namespace of mln namespace. + namespace impl {} + + /// Internal namespace of mln namespace. + namespace internal + { + /// FIXME : doc + namespace check + } // Fwd decl. template <typename E> struct Object; Index: trunk/milena/mln/core/grids.hh =================================================================== --- trunk/milena/mln/core/grids.hh (revision 1350) +++ trunk/milena/mln/core/grids.hh (revision 1351) @@ -40,8 +40,7 @@ namespace mln { - // Grids. - + /// Namespace of grids definitions. namespace grid { Index: trunk/milena/mln/math/all.hh =================================================================== --- trunk/milena/mln/math/all.hh (revision 1350) +++ trunk/milena/mln/math/all.hh (revision 1351) @@ -37,8 +37,7 @@ namespace mln { - /*! Namespace of mathematical routines. - */ + /// Namespace of mathematical routines. namespace math {} } Index: trunk/milena/mln/metal/math/all.hh =================================================================== --- trunk/milena/mln/metal/math/all.hh (revision 1350) +++ trunk/milena/mln/metal/math/all.hh (revision 1351) @@ -41,7 +41,11 @@ { /// Namespace of static mathematical functions. - namespace math {} + namespace math + { + /// Implementation namespace of metal::math namespace. + namespace impl {} + } } // end of namespace mln::metal Index: trunk/milena/mln/metal/all.hh =================================================================== --- trunk/milena/mln/metal/all.hh (revision 1350) +++ trunk/milena/mln/metal/all.hh (revision 1351) @@ -37,7 +37,12 @@ { /// Namespace of meta-programming tools. - namespace metal {} + namespace metal + { + /// Implementation namespace of metal namespace. + namespace impl {} + + } } // end of namespace mln Index: trunk/milena/mln/make/all.hh =================================================================== --- trunk/milena/mln/make/all.hh (revision 0) +++ trunk/milena/mln/make/all.hh (revision 1351) @@ -0,0 +1,75 @@ +// Copyright (C) 2007 EPITA Research and Development Laboratory +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to +// produce an executable, this file does not by itself cause the +// resulting executable to be covered by the GNU General Public +// License. This exception does not however invalidate any other +// reasons why the executable file might be covered by the GNU General +// Public License. + +#ifndef MLN_MAKE_ALL_HH +# define MLN_MAKE_ALL_HH + +/*! \file mln/make/all.hh + * + * \brief File that includes all make routines. + */ + + +namespace mln +{ + + /// Namespace of routines that help to make milena's objects. + namespace make {} + +} + +# include <mln/make/box1d.hh> +# include <mln/make/box2d.hh> +# include <mln/make/box2d_h.hh> +# include <mln/make/box3d.hh> +# include <mln/make/dpoint1d.hh> +# include <mln/make/dpoint2d.hh> +# include <mln/make/dpoint2d_h.hh> +# include <mln/make/dpoint3d.hh> +# include <mln/make/mat.hh> +# include <mln/make/pixel.hh> +# include <mln/make/pix.hh> +# include <mln/make/point1d.hh> +# include <mln/make/point2d.hh> +# include <mln/make/point2d_h.hh> +# include <mln/make/point3d.hh> +# include <mln/make/vec.hh> +# include <mln/make/voronoi.hh> +# include <mln/make/win_chamfer.hh> +# include <mln/make/window1d.hh> +# include <mln/make/window2d.hh> +# include <mln/make/window3d.hh> +# include <mln/make/w_window1d.hh> +# include <mln/make/w_window1d_int.hh> +# include <mln/make/w_window2d.hh> +# include <mln/make/w_window2d_int.hh> +# include <mln/make/w_window3d.hh> +# include <mln/make/w_window3d_int.hh> +# include <mln/make/w_window.hh> +# include <mln/make/w_window_line.hh> + +#endif // ! MLN_MAKE_ALL_HH Index: trunk/milena/mln/geom/all.hh =================================================================== --- trunk/milena/mln/geom/all.hh (revision 0) +++ trunk/milena/mln/geom/all.hh (revision 1351) @@ -0,0 +1,61 @@ +// Copyright (C) 2007 EPITA Research and Development Laboratory +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to +// produce an executable, this file does not by itself cause the +// resulting executable to be covered by the GNU General Public +// License. This exception does not however invalidate any other +// reasons why the executable file might be covered by the GNU General +// Public License. + +#ifndef MLN_GEOM_ALL_HH +# define MLN_GEOM_ALL_HH + +/*! \file mln/geom/all.hh + * + * \brief File that includes all geometry related things. + */ + + +namespace mln +{ + + /// Namespace of all things related to geometry. + namespace geom + { + /// Implementation namespace of geom namespace. + namespace impl {} + } + +} + +# include <mln/geom/bbox.hh> +# include <mln/geom/chamfer.hh> +# include <mln/geom/pmin_pmax.hh> +# include <mln/geom/seeds2tiling.hh> +# include <mln/geom/seeds2tiling_with_chamfer.hh> +# include <mln/geom/shift.hh> +# include <mln/geom/size1d.hh> +# include <mln/geom/size2d.hh> +# include <mln/geom/size3d.hh> +# include <mln/geom/sym.hh> + + +#endif // ! MLN_GEOM_ALL_HH Index: trunk/milena/mln/logical/all.hh =================================================================== --- trunk/milena/mln/logical/all.hh (revision 0) +++ trunk/milena/mln/logical/all.hh (revision 1351) @@ -0,0 +1,55 @@ +// Copyright (C) 2007 EPITA Research and Development Laboratory +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to +// produce an executable, this file does not by itself cause the +// resulting executable to be covered by the GNU General Public +// License. This exception does not however invalidate any other +// reasons why the executable file might be covered by the GNU General +// Public License. + +#ifndef MLN_LOGICAL_ALL_HH +# define MLN_LOGICAL_ALL_HH + +/*! \file mln/logical/all.hh + * + * \brief File that includes all logical operators. + */ + + +namespace mln +{ + + /// Namespace of logic. + namespace logical + { + /// Implementation namespace of logical namespace. + namespace impl {} + } + +} + +# include <mln/logical/and.hh> +# include <mln/logical/and_not.hh> +# include <mln/logical/not.hh> +# include <mln/logical/or.hh> + + +#endif // ! MLN_LOGICAL_ALL_HH Index: trunk/milena/mln/norm/all.hh =================================================================== --- trunk/milena/mln/norm/all.hh (revision 0) +++ trunk/milena/mln/norm/all.hh (revision 1351) @@ -0,0 +1,49 @@ +// Copyright (C) 2007 EPITA Research and Development Laboratory +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to +// produce an executable, this file does not by itself cause the +// resulting executable to be covered by the GNU General Public +// License. This exception does not however invalidate any other +// reasons why the executable file might be covered by the GNU General +// Public License. + +#ifndef MLN_NORM_ALL_HH +# define MLN_NORM_ALL_HH + +/*! \file mln/norm/all.hh + * + * \brief File that includes all norm routines. + */ + + +namespace mln +{ + + /// Namespace of norms. + namespace norm {} + +} + +# include <mln/norm/infty.hh> +# include <mln/norm/l1.hh> +# include <mln/norm/l2.hh> + +#endif // ! MLN_NORM_ALL_HH Index: trunk/milena/mln/util/pix.hh =================================================================== --- trunk/milena/mln/util/pix.hh (revision 1350) +++ trunk/milena/mln/util/pix.hh (revision 1351) @@ -39,6 +39,7 @@ namespace mln { + /// FIXME : doc namespace select { Index: trunk/milena/mln/labeling/all.hh =================================================================== --- trunk/milena/mln/labeling/all.hh (revision 0) +++ trunk/milena/mln/labeling/all.hh (revision 1351) @@ -0,0 +1,58 @@ +// Copyright (C) 2007 EPITA Research and Development Laboratory +// +// This file is part of the Olena Library. This library is free +// software; you can redistribute it and/or modify it under the terms +// of the GNU General Public License version 2 as published by the +// Free Software Foundation. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this library; see the file COPYING. If not, write to +// the Free Software Foundation, 51 Franklin Street, Fifth Floor, +// Boston, MA 02111-1307, USA. +// +// As a special exception, you may use this file as part of a free +// software library without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to +// produce an executable, this file does not by itself cause the +// resulting executable to be covered by the GNU General Public +// License. This exception does not however invalidate any other +// reasons why the executable file might be covered by the GNU General +// Public License. + +#ifndef MLN_LABELING_ALL_HH +# define MLN_LABELING_ALL_HH + +/*! \file mln/labeling/all.hh + * + * \brief File that includes all labeling routines. + */ + + +namespace mln +{ + + /// Namespace of labeling routines. + namespace labeling + { + /// Implementation namespace of labeling namespace. + namespace impl {} + } + +} + +# include <mln/labeling/background.hh> +# include <mln/labeling/base.hh> +# include <mln/labeling/estimate.hh> +# include <mln/labeling/flat_zones.hh> +# include <mln/labeling/foreground.hh> +# include <mln/labeling/level.hh> +# include <mln/labeling/regional_maxima.hh> +# include <mln/labeling/regional_minima.hh> + +#endif // ! MLN_LABELING_ALL_HH