oln 10.219: A bit more documentation on oln::level::frontp_connected_component()
Index: olena/ChangeLog from Roland Levillain <roland@lrde.epita.fr> * oln/level/cc.hh (frontp_connected_component): Be more precise in the description of the `nb_label' argument. Index: olena/oln/level/cc.hh --- olena/oln/level/cc.hh Tue, 27 Jul 2004 17:22:49 +0200 levill_r (oln/e/20_cc.hh 1.11.1.17 600) +++ olena/oln/level/cc.hh Fri, 29 Oct 2004 15:16:16 +0200 levill_r (oln/e/20_cc.hh 1.11.1.17 600) @@ -59,7 +59,9 @@ ** ** \arg input Image of markers. ** \arg se Neighborhood. - ** \arg nb_label Returns the number of labels (optional). + ** \arg nb_label Optional. Returns the number of labels + ** (including the background); i.e. connected components are + ** labelled from 1 to \f$nb\_label - 1\f$ (included). ** ** \return An image of type \a DestType. **
"Roland" == Roland Levillain <roland@lrde.epita.fr> writes:
Index: olena/ChangeLog from Roland Levillain <roland@lrde.epita.fr>
* oln/level/cc.hh (frontp_connected_component): Be more precise in the description of the `nb_label' argument.
Index: olena/oln/level/cc.hh --- olena/oln/level/cc.hh Tue, 27 Jul 2004 17:22:49 +0200 levill_r (oln/e/20_cc.hh 1.11.1.17 600) +++ olena/oln/level/cc.hh Fri, 29 Oct 2004 15:16:16 +0200 levill_r (oln/e/20_cc.hh 1.11.1.17 600) @@ -59,7 +59,9 @@ ** ** \arg input Image of markers. ** \arg se Neighborhood. - ** \arg nb_label Returns the number of labels (optional). + ** \arg nb_label Optional. Returns the number of labels
\param :) Par ailleurs, dans la doc, on parle à l'impératif -> return.
+ ** (including the background); i.e. connected components are + ** labelled from 1 to \f$nb\_label - 1\f$ (included). ** ** \return An image of type \a DestType. **
"Akim" == Akim Demaille <akim@epita.fr> writes:
"Roland" == Roland Levillain <roland@lrde.epita.fr> writes: Index: olena/ChangeLog from Roland Levillain <roland@lrde.epita.fr>
* oln/level/cc.hh (frontp_connected_component): Be more precise in the description of the `nb_label' argument.
Index: olena/oln/level/cc.hh --- olena/oln/level/cc.hh Tue, 27 Jul 2004 17:22:49 +0200 levill_r (oln/e/20_cc.hh 1.11.1.17 600) +++ olena/oln/level/cc.hh Fri, 29 Oct 2004 15:16:16 +0200 levill_r (oln/e/20_cc.hh 1.11.1.17 600) @@ -59,7 +59,9 @@ ** ** \arg input Image of markers. ** \arg se Neighborhood. - ** \arg nb_label Returns the number of labels (optional). + ** \arg nb_label Optional. Returns the number of labels
Akim> \param :) Right. :) Juste, je pensais qu'il serait plus sain/simple de faire les substitutions d'un seul coup sur toute le projet. À ce sujet, quelle est la meilleure façon de documenter les paramètres d'un template avec Doxygen ? Akim> Par ailleurs, dans la doc, on parle à l'impératif -> return. Ok, j'ai corrigé ça.
participants (2)
-
Akim Demaille -
Roland Levillain