- ** \brief Return its type in a string. ** \return The type in a string. ** ** Very useful to debug.
Pour une prochaine fois, "\\ Return then name of the type." est suffisant.
** \brief Neighborhood 1 dimension. ** ** It looks like structuring elements but here, when
- ** you add an element, you add his opposite.
- ** you add an element, you add its opposite. ** Points have 1 dimensions. ** */
It is a structuring element. Une définition mathématique est peut-être préférable. Points -> dpoints .
Idem en 1,2,3D.
** \brief Neighborhood. ** ** It looks like structuring elements but here, when
- ** you add an element, you add his opposite (cf mathematical
- ** you add an element, you add its opposite (cf mathematical ** definition to know more about). ** This abstract class defines several virtual methods for his
- ** subclasses. His aim is to deal with a set of deplacement points.
- ** subclasses. Its goal is to deal with a set of deplacement points. ** */
Dans le cf, tu peux écrire la définition mathématique. La partie "This abstract..." a plutôt sa place plus haut dans la hiérarchie.
typedef Exact exact_type; ///< Set the exact type.
Il faut faire une réunion pour savoir si on écrit ce genre de chose ou non (moi: non, Giovanni: oui).
** Each point of neighborhood is assigned to its opposite.
en latex: qq soit d appartient au neighborhood N, alors -d appartient à N.
** Structuring elements (set of points).
"of dpoints" ou "of oln::abstract::dpoint"
**
- ** This abstract class defines several virtual methods for his
- ** subclasses. His aim is to deal with a set of deplacement points.
- ** This abstract class defines several virtual methods for its
- ** subclasses. Its goal is to deal with a set of 'move' points.
"'move' points" -> "dpoints (vectors)"
/*!** \brief Read anything from a file.**** The "good" read function is called by template specialization.*/
"anything" ne va pas, il me semble. "good" -> "specialize" (dans plusieurs fichier)
- ** \brief Load object from a file. This could be an image but also
- ** a window or a neighborhood.
- ** \arg name The name of the file.
- ** \return The new object.
- **
- ** Here is the external interface.
- ** If you would like some examples to know how to use that, go to
- ** oln::abstract::iter
- */
Eviter le "Here is the", car c'est hors contexte lorsque on lit la doc. Eviter le "If you would like....", trop long. Le changer par : \sa oln::abstract::iter (\sa = see also = \see)
"Load ... or a neighborhood" -> "Load an image or a structural element"
"\return The new object." -> Ce qui intéresse le type qui lit la doc, c'est de savoir ce que fait load lorsque ça ne fonctionne pas: - ajouter un mot sur abstract::image::has_impl; - faire un lien vers les formats d'images supportés.
Dans plusieurs fichiers.
--- olena/oln/io/se_window.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/i/46_se_window. 1.14 640) +++ olena/oln/io/se_window.hh Mon, 15 Mar 2004 15:45:24 +0100 odou_s (oln/i/46_se_window. 1.14 640) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 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 @@ -46,13 +46,14 @@
namespace internal {
// FIXME: this code should be factorized.
///< \todo FIXME: this code should be factorized.
Bien
// FIXME: put it in a .cc file ?
/*!** \brief Read a window (1 dimension) from a file.** \arg output The new window.** \arg name The name of the file.** \return True if successful.*/
Pas bien Retirer un FXIME, c'est mal. En retirer plusieurs, c'est mal aussi.