[Olena-patches] milena r1619: Add briefs to fill out user documentation

URL: https://svn.lrde.epita.fr/svn/oln/trunk/milena ChangeLog: 2007-12-19 Guillaume Duhamel <guillaume.duhamel@lrde.epita.fr> Add briefs to fill out user documentation. * mln/accu/bbox.hh, * mln/accu/compute.hh, * mln/accu/count.hh, * mln/accu/histo.hh, * mln/accu/max.hh, * mln/accu/max_h.hh, * mln/accu/mean.hh, * mln/accu/median.hh, * mln/accu/median_alt.hh, * mln/accu/min.hh, * mln/accu/min_h.hh, * mln/accu/min_max.hh, * mln/accu/nil.hh, * mln/accu/p.hh, * mln/accu/pair.hh, * mln/accu/sum.hh, * mln/accu/take.hh, * mln/accu/v.hh, * mln/core/concept/function.hh, * mln/core/mesh_window_piter.hh, * mln/fun/v2v/linear.hh, * mln/trait/promote.hh, * mln/util/ordpair.hh, * mln/value/lut_vec.hh, * mln/value/set.hh: Fix briefs of structures/classes of these files. * doc/Makefile.am: Remove the generation of the TODO list in user documentation. --- doc/Makefile.am | 1 mln/accu/bbox.hh | 2 - mln/accu/compute.hh | 13 +++++++- mln/accu/count.hh | 9 ++++- mln/accu/histo.hh | 4 +- mln/accu/max.hh | 6 ++- mln/accu/max_h.hh | 2 - mln/accu/mean.hh | 7 ++-- mln/accu/median.hh | 4 +- mln/accu/median_alt.hh | 4 +- mln/accu/min.hh | 6 ++- mln/accu/min_h.hh | 4 +- mln/accu/min_max.hh | 2 - mln/accu/nil.hh | 8 +++-- mln/accu/p.hh | 8 +++-- mln/accu/pair.hh | 8 ++--- mln/accu/sum.hh | 6 ++- mln/accu/take.hh | 2 - mln/accu/v.hh | 8 +++-- mln/core/concept/function.hh | 66 +++++++++++++++++++++++++++++++----------- mln/core/mesh_window_piter.hh | 9 +++-- mln/fun/v2v/linear.hh | 5 +-- mln/trait/promote.hh | 8 +++-- mln/util/ordpair.hh | 9 +++-- mln/value/lut_vec.hh | 2 - mln/value/set.hh | 4 +- 26 files changed, 139 insertions(+), 68 deletions(-) Index: trunk/milena/doc/Makefile.am =================================================================== --- trunk/milena/doc/Makefile.am (revision 1618) +++ trunk/milena/doc/Makefile.am (revision 1619) @@ -32,6 +32,7 @@ -e 's,HIDE_FRIEND_COMPOUNDS = NO,HIDE_FRIEND_COMPOUNDS = YES,g' \ -e 's,HIDE_IN_BODY_DOCS = NO,HIDE_IN_BODY_DOCS = YES,g' \ -e 's,INTERNAL_DOCS = YES,INTERNAL_DOCS = NO,g' \ + -e 's,GENERATE_TODOLIST = YES,GENERATE_TODOLIST = NO,g' \ -e 's,PROJECT_NUMBER = \",PROJECT_NUMBER = \"User documentation ,g' EXTRA_DIST = Doxyfile.in Index: trunk/milena/mln/trait/promote.hh =================================================================== --- trunk/milena/mln/trait/promote.hh (revision 1618) +++ trunk/milena/mln/trait/promote.hh (revision 1619) @@ -61,9 +61,11 @@ }; - /// Default case when one type is involved twice: the promotion - /// type is the same as the input type (so actually there is no - /// promotion). + /*! + * \brief Default case when one type is involved twice: the + * promotion type is the same as the input type (so actually there + * is no promotion). + */ template <typename T> struct set_binary_< promote, Object, T, Object, T > { Index: trunk/milena/mln/core/mesh_window_piter.hh =================================================================== --- trunk/milena/mln/core/mesh_window_piter.hh (revision 1618) +++ trunk/milena/mln/core/mesh_window_piter.hh (revision 1619) @@ -28,9 +28,12 @@ #ifndef MLN_CORE_MESH_WINDOW_PITER_HH # define MLN_CORE_MESH_WINDOW_PITER_HH -// FIXME: Doc. - -// FIXME: Shall we rename `piter' as `qiter'? +/*! + * \file mln/core/mesh_window_piter.hh + * + * \brief Definition of point iterator of mesh window. + * + */ # include <mln/core/concept/point_iterator.hh> # include <mln/core/mesh_p.hh> Index: trunk/milena/mln/core/concept/function.hh =================================================================== --- trunk/milena/mln/core/concept/function.hh (revision 1618) +++ trunk/milena/mln/core/concept/function.hh (revision 1619) @@ -41,6 +41,7 @@ /// \{ /// Fwd decls. + template <typename E> struct Function; template <typename E> struct Function_v2v; template <typename E> struct Function_i2v; @@ -85,8 +86,12 @@ template <> struct Function_v2v<void> { typedef Function<void> super; }; - /// Base class for implementation of function-objects from value to - /// value. + /*! + * \brief Base class for implementation of function-objects from + * value to value. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Function_v2v : public Function<E> { @@ -102,8 +107,13 @@ template <> struct Function_i2v<void> { typedef Function_v2v<void> super; }; - /// Base class for implementation of function-objects from index to - /// value. + + /*! + * \brief Base class for implementation of function-objects from + * index to value. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Function_i2v : public Function_v2v<E> { @@ -119,8 +129,12 @@ template <> struct Function_p2v<void> { typedef Function_v2v<void> super; }; - /// Base class for implementation of function-objects from point to - /// value. + /*! + * \brief Base class for implementation of function-objects from point to + * value. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Function_p2v : public virtual Function_v2v<E> { @@ -136,8 +150,12 @@ template <> struct Function_v2b<void> { typedef Function_v2v<void> super; }; - /// Base class for implementation of function-objects from value to - /// bool. + /*! + * \brief Base class for implementation of function-objects from value to + * bool. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Function_v2b : public virtual Function_v2v<E> { @@ -154,8 +172,12 @@ template <> struct Function_p2b<void> { typedef Function_p2v<void> super; }; // FIXME - /// Base class for implementation of function-objects from point to - /// bool. + /*! + * \brief Base class for implementation of function-objects from point to + * bool. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Function_p2b : public Function_p2v<E>, public Function_v2b<E> @@ -173,8 +195,12 @@ template <> struct Function_p2p<void> { typedef Function_p2v<void> super; }; // FIXME - /// Base class for implementation of function-objects from point to - /// point. + /*! + * \brief Base class for implementation of function-objects from point to + * point. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Function_p2p : public Function_p2v<E> { @@ -190,8 +216,12 @@ template <> struct Function_x2x<void> { typedef Function_v2v<void> super; }; // FIXME - /// Base class for implementation of function-objects from vector to - /// vector. + /*! + * \brief Base class for implementation of function-objects from vector to + * vector. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Function_x2x : public Function_v2v<E> { @@ -203,8 +233,12 @@ // Vector <-> Vector. - /// Base class for implementation of bijective function-objects from - /// vector to vector. + /*! + * \brief Base class for implementation of bijective function-objects from + * vector to vector. + * + * The parameter \a E is the exact type. + */ template <typename E> struct Bijection_x2x : public Function_x2x< E > { Index: trunk/milena/mln/accu/nil.hh =================================================================== --- trunk/milena/mln/accu/nil.hh (revision 1618) +++ trunk/milena/mln/accu/nil.hh (revision 1619) @@ -47,7 +47,8 @@ namespace accu { - /*! Define an accumulator that does nothing. + /*! + * \brief Define an accumulator that does nothing. */ template <typename T> struct nil_ : public mln::accu::internal::base_< util::ignore , nil_<T> > @@ -66,8 +67,9 @@ }; - - // FIXME: Doc! + /*! + * \brief Meta accumulator for nil. + */ struct nil : public Meta_Accumulator< nil > { template <typename V> Index: trunk/milena/mln/accu/min.hh =================================================================== --- trunk/milena/mln/accu/min.hh (revision 1618) +++ trunk/milena/mln/accu/min.hh (revision 1619) @@ -46,7 +46,7 @@ { - /*! Generic min accumulator class. + /*! \brief Generic min accumulator class. * * The parameter \c T is the type of values. */ @@ -74,7 +74,9 @@ template <typename I> struct min_< util::pix<I> >; - // FIXME: Doc! + /*! + * \brief Meta accumulator for min. + */ struct min : public Meta_Accumulator< min > { template <typename T> Index: trunk/milena/mln/accu/take.hh =================================================================== --- trunk/milena/mln/accu/take.hh (revision 1618) +++ trunk/milena/mln/accu/take.hh (revision 1619) @@ -44,7 +44,7 @@ namespace accu { - /*! Make an accumulator take the pixels of the image \p input. + /*! \brief Make an accumulator take the pixels of the image \p input. * * \param[in] input The input image. * \param[in,out] a The accumulator. Index: trunk/milena/mln/accu/max.hh =================================================================== --- trunk/milena/mln/accu/max.hh (revision 1618) +++ trunk/milena/mln/accu/max.hh (revision 1619) @@ -46,7 +46,7 @@ { - /*! Generic max accumulator class. + /*! \brief Generic max accumulator class. * * The parameter \c T is the type of values. */ @@ -74,7 +74,9 @@ template <typename I> struct max_< util::pix<I> >; - // FIXME: Doc! + /*! + * \brief Meta accumulator for max. + */ struct max : public Meta_Accumulator< max > { template <typename T> Index: trunk/milena/mln/accu/histo.hh =================================================================== --- trunk/milena/mln/accu/histo.hh (revision 1618) +++ trunk/milena/mln/accu/histo.hh (revision 1619) @@ -50,7 +50,8 @@ { - /*! Generic histogram class over a value set with type \c S. + /*! + * \brief Generic histogram class over a value set with type \c S. */ template <typename S> struct histo : public mln::accu::internal::base_< const std::vector<std::size_t>& , histo<S> > @@ -83,7 +84,6 @@ std::size_t sum_; }; - template <typename S> std::ostream& operator<<(std::ostream& ostr, const histo<S>& h); Index: trunk/milena/mln/accu/min_max.hh =================================================================== --- trunk/milena/mln/accu/min_max.hh (revision 1618) +++ trunk/milena/mln/accu/min_max.hh (revision 1619) @@ -50,7 +50,7 @@ namespace accu { - /*! Generic min and max accumulator class. + /*! \brief Generic min and max accumulator class. * * The parameter \c V is the type of values. */ Index: trunk/milena/mln/accu/count.hh =================================================================== --- trunk/milena/mln/accu/count.hh (revision 1618) +++ trunk/milena/mln/accu/count.hh (revision 1619) @@ -44,7 +44,10 @@ { - /*! Generic counter accumulator class. + /*! + * \brief Generic counter accumulator class. + * + * The parameter \a T is the type to be count. */ template <typename T> struct count_ : public mln::accu::internal::base_< std::size_t , count_<T> > @@ -67,7 +70,9 @@ }; - // FIXME: Doc! + /*! + * \brief Meta accumulator for count. + */ struct count : public Meta_Accumulator< count > { template <typename T> Index: trunk/milena/mln/accu/bbox.hh =================================================================== --- trunk/milena/mln/accu/bbox.hh (revision 1618) +++ trunk/milena/mln/accu/bbox.hh (revision 1619) @@ -44,7 +44,7 @@ { - /*! Generic bbox accumulator class. + /*! \brief Generic bbox accumulator class. * * The parameter \c P is the type of points. */ Index: trunk/milena/mln/accu/min_h.hh =================================================================== --- trunk/milena/mln/accu/min_h.hh (revision 1618) +++ trunk/milena/mln/accu/min_h.hh (revision 1619) @@ -44,8 +44,8 @@ { - /*! Generic min function based on histogram over a value set with - * type \c S. + /*! \brief Generic min function based on histogram over a value + * set with type \c S. */ template <typename S> struct min_h : public mln::accu::internal::base_< mln_value(S) , min_h<S> > Index: trunk/milena/mln/accu/pair.hh =================================================================== --- trunk/milena/mln/accu/pair.hh (revision 1618) +++ trunk/milena/mln/accu/pair.hh (revision 1619) @@ -49,7 +49,7 @@ { - /*! Generic pair of accumulators. + /*! \brief Generic pair of accumulators. * * The parameter \c T is the type of values. * @@ -81,9 +81,9 @@ A2 a2_; }; - - - // FIXME: Doc! + /*! + * \brief Meta accumulator for pair. + */ template <typename A1, typename A2> struct pair : public Meta_Accumulator< pair<A1,A2> > { Index: trunk/milena/mln/accu/max_h.hh =================================================================== --- trunk/milena/mln/accu/max_h.hh (revision 1618) +++ trunk/milena/mln/accu/max_h.hh (revision 1619) @@ -44,7 +44,7 @@ { - /*! Generic max function based on histogram over a value set with + /*! \brief Generic max function based on histogram over a value set with * type \c S. */ template <typename S> Index: trunk/milena/mln/accu/median.hh =================================================================== --- trunk/milena/mln/accu/median.hh (revision 1618) +++ trunk/milena/mln/accu/median.hh (revision 1619) @@ -44,8 +44,8 @@ { - /*! Generic median function based on histogram over a value set - * with type \c S. + /*! \brief Generic median function based on histogram over a value + * set with type \c S. */ template <typename S> struct median : public mln::accu::internal::base_< mln_value(S), median<S> > Index: trunk/milena/mln/accu/median_alt.hh =================================================================== --- trunk/milena/mln/accu/median_alt.hh (revision 1618) +++ trunk/milena/mln/accu/median_alt.hh (revision 1619) @@ -44,8 +44,8 @@ { - /*! Generic median_alt function based on histogram over a value set - * with type \c S. + /*! \brief Generic median_alt function based on histogram over a + * value set with type \c S. */ template <typename S> struct median_alt : : public mln::accu::internal::base_< mln_value(S), median_alt<S> > Index: trunk/milena/mln/accu/p.hh =================================================================== --- trunk/milena/mln/accu/p.hh (revision 1618) +++ trunk/milena/mln/accu/p.hh (revision 1619) @@ -46,7 +46,8 @@ { - /*! Generic p of accumulators. + /*! + * \brief Generic p of accumulators. * * The parameter \c V is the type of values. */ @@ -72,8 +73,9 @@ }; - - // FIXME: Doc! + /*! + * \brief Meta accumulator for p. + */ template <typename mA> struct p : public Meta_Accumulator< p<mA> > { Index: trunk/milena/mln/accu/sum.hh =================================================================== --- trunk/milena/mln/accu/sum.hh (revision 1618) +++ trunk/milena/mln/accu/sum.hh (revision 1619) @@ -48,7 +48,7 @@ { - /*! Generic sum accumulator class. + /*! \brief Generic sum accumulator class. * * Parameter \c T is the type of values that we sum. Parameter \c * S is the type to store the value sum; the default type of @@ -78,7 +78,9 @@ struct sum_< util::pix<I>, S >; - // FIXME: Doc! + /*! + * \brief Meta accumulator for sum. + */ struct sum : public Meta_Accumulator< sum > { template <typename T, typename S = mln_sum(T)> Index: trunk/milena/mln/accu/v.hh =================================================================== --- trunk/milena/mln/accu/v.hh (revision 1618) +++ trunk/milena/mln/accu/v.hh (revision 1619) @@ -45,7 +45,8 @@ { - /*! Generic v of accumulators. + /*! + * \brief Generic val of accumulators. */ template <typename A> struct val_ : public mln::accu::internal::base_< mln_result(A) , val_<A> > @@ -80,8 +81,9 @@ }; - - // FIXME: Doc! + /*! + * \brief Meta accumulator for val. + */ template <typename mA> struct val : public Meta_Accumulator< val<mA> > { Index: trunk/milena/mln/accu/compute.hh =================================================================== --- trunk/milena/mln/accu/compute.hh (revision 1618) +++ trunk/milena/mln/accu/compute.hh (revision 1619) @@ -46,7 +46,7 @@ namespace accu { - /*! Make an accumulator compute the pixels of the image \p input. + /*! \brief Make an accumulator compute the pixels of the image \p input. * * \param[in] input The input image. * @@ -61,7 +61,16 @@ compute(const Image<I>& input); - // FIXME: Doc! + /*! \brief Make an accumulator compute the pixels of the image \p input. + * + * \param[in] input The input image. + * + * This routine runs: \n + * a.take(make::pix(input, p)); + * on all pixels on the images. + * + * \warning This routine does not perform a.init(). + */ template <typename A, typename I> mln_accu_with(A, util::pix<I>)::result compute(const Image<I>& input); Index: trunk/milena/mln/accu/mean.hh =================================================================== --- trunk/milena/mln/accu/mean.hh (revision 1618) +++ trunk/milena/mln/accu/mean.hh (revision 1619) @@ -47,7 +47,7 @@ { - /*! Generic mean accumulator class. + /*! \brief Generic mean accumulator class. * * Parameter \c T is the type of values that we sum. Parameter \c * S is the type to store the sum of values; the default type of @@ -83,8 +83,9 @@ struct mean_< util::pix<I>, S,M >; - - // FIXME: Doc! + /*! + * \brief Meta accumulator for mean. + */ struct mean : public Meta_Accumulator< mean > { template < typename T, Index: trunk/milena/mln/value/lut_vec.hh =================================================================== --- trunk/milena/mln/value/lut_vec.hh (revision 1618) +++ trunk/milena/mln/value/lut_vec.hh (revision 1619) @@ -51,7 +51,7 @@ template <typename S> struct bkd_viter_; - /*! Class that defines FIXME + /*! \brief Class that defines FIXME * * \warning This is a multi-set!!! * FIXME Index: trunk/milena/mln/value/set.hh =================================================================== --- trunk/milena/mln/value/set.hh (revision 1618) +++ trunk/milena/mln/value/set.hh (revision 1619) @@ -46,10 +46,12 @@ namespace internal { + /// \internal template <typename T, typename E, bool is_lowq = false> struct set_selector_ // no inheritance {}; + /// \internal template <typename T, typename E> struct set_selector_< T, E, true > // lowq so iterable : @@ -60,7 +62,7 @@ - /*! Class that defines the set of values of type \c T. + /*! \brief Class that defines the set of values of type \c T. * * This is the exhaustive set of values obtainable from type \c T. */ Index: trunk/milena/mln/fun/v2v/linear.hh =================================================================== --- trunk/milena/mln/fun/v2v/linear.hh (revision 1618) +++ trunk/milena/mln/fun/v2v/linear.hh (revision 1619) @@ -45,10 +45,9 @@ namespace v2v { - /*! Linear function. - * + /*! + *\brief Linear function. * f(v) = a * v + b. - * * \c V is the type of input values; \c T is the type used to * compute the result; \c R is the result type. * Index: trunk/milena/mln/util/ordpair.hh =================================================================== --- trunk/milena/mln/util/ordpair.hh (revision 1618) +++ trunk/milena/mln/util/ordpair.hh (revision 1619) @@ -42,9 +42,12 @@ namespace util { - /// Ordered pair structure s.a. this->first <= this->second; - /// ordered pairs are partially ordered using lexicographical - /// ordering. + /*! + * \brief Ordered pair structure s.a. this->first <= this->second; + * ordered pairs are partially ordered using lexicographical + * ordering. + * + */ template <typename T> struct ordpair_ : public mln::Object< ordpair_<T> > {