[Olena-patches] olena-2.0-379-ga58bc61 Improve documentation in mln/canvas.

* mln/canvas/browsing/backdiagonal2d.hh, * mln/canvas/browsing/diagonal2d.hh, * mln/canvas/browsing/dir_struct_elt_incr_update.hh, * mln/canvas/browsing/directional.hh, * mln/canvas/browsing/fwd.hh, * mln/canvas/browsing/snake_fwd.hh, * mln/canvas/browsing/snake_generic.hh: Here. --- milena/ChangeLog | 12 +++++ milena/mln/canvas/browsing/backdiagonal2d.hh | 35 +++++++------- milena/mln/canvas/browsing/diagonal2d.hh | 35 +++++++------- .../canvas/browsing/dir_struct_elt_incr_update.hh | 34 +++++++------- milena/mln/canvas/browsing/directional.hh | 48 ++++++++++---------- milena/mln/canvas/browsing/fwd.hh | 20 ++++----- milena/mln/canvas/browsing/snake_fwd.hh | 26 +++++----- milena/mln/canvas/browsing/snake_generic.hh | 36 +++++++-------- 8 files changed, 126 insertions(+), 120 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 144575e..45496e2 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,17 @@ 2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Improve documentation in mln/canvas. + + * mln/canvas/browsing/backdiagonal2d.hh, + * mln/canvas/browsing/diagonal2d.hh, + * mln/canvas/browsing/dir_struct_elt_incr_update.hh, + * mln/canvas/browsing/directional.hh, + * mln/canvas/browsing/fwd.hh, + * mln/canvas/browsing/snake_fwd.hh, + * mln/canvas/browsing/snake_generic.hh: Here. + +2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Improve look'n feel of general documentation. * doc/Doxyfile.in: Improve documentation output. diff --git a/milena/mln/canvas/browsing/backdiagonal2d.hh b/milena/mln/canvas/browsing/backdiagonal2d.hh index 2648f97..57f5a35 100644 --- a/milena/mln/canvas/browsing/backdiagonal2d.hh +++ b/milena/mln/canvas/browsing/backdiagonal2d.hh @@ -58,26 +58,27 @@ namespace mln * - final(): Will be called at the end. * * F shall features : \n - * { \n - * --- as types: \n - * I; \n - * --- as attributes: \n - * dim; \n - * dir; // and test dir < dim \n - * input; \n - * p; \n - * --- as methods: \n - * void init(); \n - * void next(); \n - * void final(); \n - * } \n + - As types: + + I; + - As attributes: + + dim; + + dir; // and test dir < dim + + input; + + p; + - As methods: + + void init(); + + void next(); + + void final(); + \endverbatim * * Example : \n * - * -------> - * | 4 7 9 - * | 2 5 8 - * | 1 3 6 + \verbatim + -------> + | 4 7 9 + | 2 5 8 + | 1 3 6 + \endverbatim * * \ingroup modcanvasbrowsing */ diff --git a/milena/mln/canvas/browsing/diagonal2d.hh b/milena/mln/canvas/browsing/diagonal2d.hh index 4dc8b4f..3b91af2 100644 --- a/milena/mln/canvas/browsing/diagonal2d.hh +++ b/milena/mln/canvas/browsing/diagonal2d.hh @@ -57,27 +57,26 @@ namespace mln * - final(): Will be called at the end. * * F shall features : \n - * { \n - * --- as types: \n - * I; \n - * --- as attributes: \n - * dim; \n - * dir; // and test dir < dim \n - * input; \n - * p; \n - * --- as methods: \n - * void init(); \n - * void next(); \n - * void final(); \n - * } \n + - As types: + + I; + - As attributes: + + dim; + + dir; // and test dir < dim + + input; + + p; + - As methods: + + void init(); + + void next(); + + void final(); * * Example : \n * - * | 1 3 6 - * | 2 5 8 - * | 4 7 9 - * L------> - * + \verbatim + -------> + | 1 3 6 + | 2 5 8 + | 4 7 9 + \endverbatim * * \ingroup modcanvasbrowsing */ diff --git a/milena/mln/canvas/browsing/dir_struct_elt_incr_update.hh b/milena/mln/canvas/browsing/dir_struct_elt_incr_update.hh index 2bc2fc9..719fe15 100644 --- a/milena/mln/canvas/browsing/dir_struct_elt_incr_update.hh +++ b/milena/mln/canvas/browsing/dir_struct_elt_incr_update.hh @@ -64,24 +64,22 @@ namespace mln * provided by the functor). * - final() : Will be called at the end. * - * F shall features : \n - * { \n - * --- as types: \n - * I; \n - * --- as attributes: \n - * dim; \n - * dir; // and test dir < dim \n - * input; \n - * p; \n - * length; \n - * --- as methods: \n - * void init(); \n - * void init_line(); \n - * void add_point(q) \n - * void remove_point(q) \n - * void next(); \n - * void final(); \n - * } \n + * F shall features : \n + - As types: + + I + - As attributes: + + dim + + dir // and test dir < dim + + input + + p + + length + - As methods: + + void init() + + void init_line() + + void add_point(q) + + void remove_point(q) + + void next() + + void final() * * * \ingroup modcanvasbrowsing diff --git a/milena/mln/canvas/browsing/directional.hh b/milena/mln/canvas/browsing/directional.hh index 8caad7c..f6a9dcd 100644 --- a/milena/mln/canvas/browsing/directional.hh +++ b/milena/mln/canvas/browsing/directional.hh @@ -57,33 +57,33 @@ namespace mln * - final(): Will be called at the end. * * F shall features : \n - * { \n - * --- as types: \n - * I; \n - * --- as attributes: \n - * dim; \n - * dir; // and test dir < dim \n - * input; \n - * p; \n - * --- as methods: \n - * void init(); \n - * void next(); \n - * void final(); \n - * } \n + - As types: + + I + - As attributes: + + dim + + dir // and test dir < dim + + input + + p + - As methods: + + void init() + + void next() + + void final() * * Example : \n * - * 1 0 0 - * 2 0 0 - * 3 0 0 - * - * 4 0 0 - * 5 0 0 - * 6 0 0 - * - * 7 0 0 - * 8 0 0 - * 9 0 0 + \verbatim + 1 0 0 + 2 0 0 + 3 0 0 + + 4 0 0 + 5 0 0 + 6 0 0 + + 7 0 0 + 8 0 0 + 9 0 0 + \endverbatim * * * \ingroup modcanvasbrowsing diff --git a/milena/mln/canvas/browsing/fwd.hh b/milena/mln/canvas/browsing/fwd.hh index 9c2800b..7309968 100644 --- a/milena/mln/canvas/browsing/fwd.hh +++ b/milena/mln/canvas/browsing/fwd.hh @@ -57,17 +57,15 @@ namespace mln * - final(): Will be called at the end. * * F shall feature: \n - * { \n - * --- as typedef: \n - * I; \n - * --as attributes: \n - * input; \n - * p; \n - * --- as method: \n - * void init(); \n - * void next(); \n - * void final(); \n - * } \n + - As typedef: + + I + - As attributes: + + input + + p + - As method: + + void init() + + void next() + + void final() * * \ingroup modcanvasbrowsing */ diff --git a/milena/mln/canvas/browsing/snake_fwd.hh b/milena/mln/canvas/browsing/snake_fwd.hh index fd940ce..bebde63 100644 --- a/milena/mln/canvas/browsing/snake_fwd.hh +++ b/milena/mln/canvas/browsing/snake_fwd.hh @@ -49,9 +49,11 @@ namespace mln * This canvas browse all the point of an image 'input' like * this : * - * -------> - * <------' - * '------> + \verbatim + -------> + <------' + '------> + \endverbatim * * The fonctor should provide (In addition to 'input') four * methods : @@ -68,16 +70,14 @@ namespace mln * Warning: This canvas works only on 2D. * * F shall feature: \n - * { \n - * --- as attributes: \n - * input; \n - * p; \n - * --- as methods: \n - * void init(); \n - * void down(); \n - * void fwd(); \n - * void bkd(); \n - * } \n + - As attributes: + + input + + p + - As methods: + + void init() + + void down() + + void fwd() + + void bkd() * * * \ingroup modcanvasbrowsing diff --git a/milena/mln/canvas/browsing/snake_generic.hh b/milena/mln/canvas/browsing/snake_generic.hh index 7360dbe..980fec0 100644 --- a/milena/mln/canvas/browsing/snake_generic.hh +++ b/milena/mln/canvas/browsing/snake_generic.hh @@ -47,29 +47,27 @@ namespace mln /*! \brief Multidimentional Browsing in a given-way. * * F shall feature: \n - * { \n - * --- as attributes: \n - * input; \n - * p; \n - * --- as methods: \n - * void init(); \n - * void *() moves[]; \n - * dpsite dps[]; \n - * } \n + - As attributes: + + input + + p + - As methods: + + void init() + + void *() moves[] + + dpsite dps[] * - * init is called before browsing + * init() is called before browsing * * The snake follow dimension using the delta point site of dps. - * dps[0] = delta psite following the global dimension (forward) - * dps[1] = delta psite following the 2nd dimension to follow (forward). - * dps[2] = delta psite following the 2nd dimension to follow (backward). - * dps[3] = delta psite following the 3nd dimension to follow (forward). - * dps[3] = delta psite following the 3nd dimension to follow (backward). + * - dps[0] = delta psite following the global dimension (forward) + * - dps[1] = delta psite following the 2nd dimension to follow (forward). + * - dps[2] = delta psite following the 2nd dimension to follow (backward). + * - dps[3] = delta psite following the 3nd dimension to follow (forward). + * - dps[3] = delta psite following the 3nd dimension to follow (backward). * - * moves contains pointer to f's members. These merbers will be call in each time - * the snake progress in the correct dimension : - * - * moves[i] is called at each move following the delta psite dps[i] + * moves contains pointer to f's members. These members will be + * called each time the snake progress in the correct dimension: + * moves[i] is called at each move following the delta psite + * dps[i]. * * * \ingroup modcanvasbrowsing -- 1.7.2.5