[Olena-patches] olena: olena-2.0-559-ge6d70f7 mln/core/concept/function.hh: Document function interface for each concept.

--- milena/ChangeLog | 5 + milena/mln/core/concept/function.hh | 160 +++++++++++++++++++++++++++-------- 2 files changed, 130 insertions(+), 35 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index cfbca01..851fe53 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,10 @@ 2013-04-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + * mln/core/concept/function.hh: Document function interface for + each concept. + +2013-04-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Kill Doxygen warnings. * mln/data/convert.hh: Add a missing \overload. diff --git a/milena/mln/core/concept/function.hh b/milena/mln/core/concept/function.hh index ecd9db0..1da6247 100644 --- a/milena/mln/core/concept/function.hh +++ b/milena/mln/core/concept/function.hh @@ -94,13 +94,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from - /// Nil to value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from + Nil to value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_n2v<my_function> + { + typedef my_result_type result; + typedef void argument; + + result operator()() const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_n2v : public Function<E> { @@ -121,13 +139,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from - /// value to value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from + value to value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_v2v<my_function> + { + typedef my_result_type result; + typedef my_argument_type argument; + + result operator()(const argument& v) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_v2v : public Function<E> { @@ -149,13 +185,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// value to a Boolean. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + value to a Boolean. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_v2b<my_function> + { + typedef bool result; + typedef my_argument_type argument; + + result operator()(const argument& v) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_v2b : public virtual Function_v2v<E> { @@ -178,13 +232,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// couple of values to a value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + couple of values to a value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_vv2v<my_function> + { + typedef my_result_type result; + typedef my_argument_type argument; + + result operator()(const argument& v1, const argument& v2) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_vv2v : public Function<E> { @@ -205,13 +277,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// couple of values to a Boolean. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + couple of values to a Boolean. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_vv2b<my_function> + { + typedef bool result; + typedef my_argument_type argument; + + result operator()(const argument& v1, const argument& v2) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_vv2b : public Function<E> { -- 1.7.2.5