[Olena-patches] milena r1614: Add main page for Doxygen documentation

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena ChangeLog: 2007-12-17 Guillaume Duhamel &lt;guillaume.duhamel(a)lrde.epita.fr&gt; Add main page for Doxygen documentation. * mln/convert/all.hh, * mln/level/all.hh, * mln/level/paste.hh, * tests/level/paste_full.cc: Fix typo. * mln/core/concept/object.hh: Add main page for Doxygen. --- mln/convert/all.hh | 2 - mln/core/concept/object.hh | 78 +++++++++++++++++++++++++++++++++++++++++++++ mln/level/all.hh | 2 - mln/level/paste.hh | 4 +- tests/level/paste_full.cc | 3 + 5 files changed, 86 insertions(+), 3 deletions(-) Index: trunk/milena/tests/level/paste_full.cc =================================================================== --- trunk/milena/tests/level/paste_full.cc (revision 1613) +++ trunk/milena/tests/level/paste_full.cc (revision 1614) @@ -142,6 +142,7 @@ chck(input, output); } + /// FIXME : Uncomment this when it will be possible // { // image1d<I> in (cols); // image_if<image1d<I>, f_box1d_t> input(in, f_b1); @@ -173,6 +174,7 @@ chck(input, output); } + /// FIXME : Uncomment this when it will be possible // { // image2d<I> in (rows, cols); // image_if<image2d<I>, f_box2d_t> input(in, f_b2); @@ -204,6 +206,7 @@ chck(input, output); } + /// FIXME : Uncomment this when it will be possible // { // image3d<I> in (slis, rows, cols); // image_if<image3d<I>, f_box3d_t> input(in, f_b3); Index: trunk/milena/mln/core/concept/object.hh =================================================================== --- trunk/milena/mln/core/concept/object.hh (revision 1613) +++ trunk/milena/mln/core/concept/object.hh (revision 1614) @@ -46,6 +46,84 @@ # include <mln/metal/ret.hh> +/*! \mainpage Documentation of milena + * + * \section intro_sec Introduction + * + * This is the documentation of milena. + * + * \section tools_subsec Tools required. + * FIXME. + * + * \section mln_sec Overview of milena. + * + * <UL> + * <LI> \ref mln + * <LI> \ref mln::accu + * <LI> \ref mln::arith + * <LI> \ref mln::border + * <LI> \ref mln::canvas + * <LI> \ref mln::convert + * <LI> \ref mln::debug + * <LI> \ref mln::display + * <LI> \ref mln::draw + * <LI> \ref mln::estim + * <LI> \ref mln::fun + * <LI> \ref mln::geom + * <LI> \ref mln::histo + * <LI> \ref mln::io + * <LI> \ref mln::labeling + * <LI> \ref mln::level + * <LI> \ref mln::linear + * <LI> \ref mln::literal + * <LI> \ref mln::logical + * <LI> \ref mln::make + * <LI> \ref mln::math + * <LI> \ref mln::metal + * <LI> \ref mln::morpho + * <LI> \ref mln::norm + * <LI> \ref mln::pw + * <LI> \ref mln::set + * <LI> \ref mln::tag + * <LI> \ref mln::test + * <LI> \ref mln::trace + * <LI> \ref mln::trait + * <LI> \ref mln::util + * <LI> \ref mln::value + * <LI> \ref mln::win + * + * \section copyright Copyright and License. + * 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. + * + */ + + + /*! \namespace mln * \brief The namespace mln corresponds to the Milena (mini-Olena) project. * Index: trunk/milena/mln/level/all.hh =================================================================== --- trunk/milena/mln/level/all.hh (revision 1613) +++ trunk/milena/mln/level/all.hh (revision 1614) @@ -31,6 +31,7 @@ /*! \file mln/level/all.hh * * \brief File that includes all level-related routines. + * */ @@ -66,7 +67,6 @@ # include <mln/level/memset_.hh> # include <mln/level/naive/all.hh> # include <mln/level/paste.hh> -# include <mln/level/paste.spe.hh> # include <mln/level/saturate.hh> # include <mln/level/sort_points.hh> # include <mln/level/stretch.hh> Index: trunk/milena/mln/level/paste.hh =================================================================== --- trunk/milena/mln/level/paste.hh (revision 1613) +++ trunk/milena/mln/level/paste.hh (revision 1614) @@ -31,6 +31,7 @@ /*! \file mln/level/paste.hh * * \brief Paste the contents of an image into another one. + * */ # include <mln/core/concept/image.hh> @@ -48,7 +49,8 @@ namespace level { - /*! Paste the contents of image \p data into the image \p + /*! + * \brief Paste the contents of image \p data into the image \p * destination. * * \param[in] data The input image providing pixels values. Index: trunk/milena/mln/convert/all.hh =================================================================== --- trunk/milena/mln/convert/all.hh (revision 1613) +++ trunk/milena/mln/convert/all.hh (revision 1614) @@ -36,7 +36,7 @@ namespace mln { - /// \internal Namespace of convertion routines. + /// Namespace of convertion routines. namespace convert {} }