* mln/arith/minus.hh,
* mln/fun/vv2v/diff_abs.hh,
* mln/math/diff_abs.hh:
Here.
---
milena/ChangeLog | 9 +++++++++
milena/mln/arith/minus.hh | 23 +++++++++++------------
milena/mln/fun/vv2v/diff_abs.hh | 17 +++++++++++------
milena/mln/math/diff_abs.hh | 15 ++++++++-------
4 files changed, 39 insertions(+), 25 deletions(-)
diff --git a/milena/ChangeLog b/milena/ChangeLog
index 52f9172..7b3aaea 100644
--- a/milena/ChangeLog
+++ b/milena/ChangeLog
@@ -1,5 +1,14 @@
2013-10-09 Roland Levillain <roland(a)lrde.epita.fr>
+ Milena: Fix and update the Doxygen documentation.
+
+ * mln/arith/minus.hh,
+ * mln/fun/vv2v/diff_abs.hh,
+ * mln/math/diff_abs.hh:
+ Here.
+
+2013-10-09 Roland Levillain <roland(a)lrde.epita.fr>
+
Milena: Aesthetic changes.
* mln/arith/minus.hh,
diff --git a/milena/mln/arith/minus.hh b/milena/mln/arith/minus.hh
index bd3b09d..334e09d 100644
--- a/milena/mln/arith/minus.hh
+++ b/milena/mln/arith/minus.hh
@@ -28,8 +28,7 @@
# define MLN_ARITH_MINUS_HH
/// \file
-///
-/// Point-wise substraction between images.
+/// \brief Point-wise subtraction between images.
///
/// \todo Speedup; some versions are not optimal.
@@ -85,7 +84,7 @@ namespace mln
namespace arith
{
- /// Point-wise addition of images \p lhs and \p rhs.
+ /// Point-wise subtraction of images \p lhs and \p rhs.
/*!
* \param[in] lhs First operand image.
* \param[in] rhs Second operand image.
@@ -98,7 +97,7 @@ namespace mln
minus(const Image<L>& lhs, const Image<R>& rhs);
- /// Point-wise addition of images \p lhs and \p rhs.
+ /// Point-wise subtraction of images \p lhs and \p rhs.
/*!
* \param[in] lhs First operand image.
* \param[in] rhs Second operand image.
@@ -113,7 +112,7 @@ namespace mln
const Function_v2v<F>& f);
- /// Point-wise addition of images \p lhs and \p rhs.
+ /// Point-wise subtraction of images \p lhs and \p rhs.
/*!
* \param[in] lhs First operand image.
* \param[in] rhs Second operand image.
@@ -128,12 +127,12 @@ namespace mln
minus(const Image<L>& lhs, const Image<R>& rhs);
- /// Point-wise addition of image \p rhs in image \p lhs.
+ /// Point-wise subtraction of image \p rhs in image \p lhs.
/*!
- * \param[in,out] lhs First operand image (subject to addition).
- * \param[in] rhs Second operand image (to be added to \p lhs).
+ * \param[in,out] lhs First operand image (subject to subtraction).
+ * \param[in] rhs Second operand image (to be subtracted to \p lhs).
*
- * This addition performs: \n
+ * This subtraction performs: \n
* for all p of rhs.domain \n
* lhs(p) -= rhs(p)
*
@@ -144,7 +143,7 @@ namespace mln
minus_inplace(Image<L>& lhs, const Image<R>& rhs);
- /// Point-wise addition of the value \p val to image \p input.
+ /// Point-wise subtraction of the value \p val to image \p input.
/*!
* \param[in] input The image.
* \param[in] val The value.
@@ -157,7 +156,7 @@ namespace mln
minus_cst(const Image<I>& input, const V& val);
- /// Point-wise addition of the value \p val to image \p input.
+ /// Point-wise subtraction of the value \p val to image \p input.
/*!
* \param[in] input The image.
* \param[in] val The value.
@@ -172,7 +171,7 @@ namespace mln
const Function_v2v<F>& f);
- /// Point-wise addition of the value \p val to image \p input.
+ /// Point-wise subtraction of the value \p val to image \p input.
/*!
* \param[in,out] input The image.
* \param[in] val The value.
diff --git a/milena/mln/fun/vv2v/diff_abs.hh b/milena/mln/fun/vv2v/diff_abs.hh
index abde9d2..3be04d7 100644
--- a/milena/mln/fun/vv2v/diff_abs.hh
+++ b/milena/mln/fun/vv2v/diff_abs.hh
@@ -1,4 +1,5 @@
-// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE)
+// Copyright (C) 2008, 2009, 2013 EPITA Research and Development
+// Laboratory (LRDE).
//
// This file is part of Olena.
//
@@ -27,8 +28,7 @@
# define MLN_FUN_VV2V_DIFF_ABS_HH
/// \file
-/// \brief Computing the absolute difference between two values using
-/// a functor.
+/// \brief Functor computing the absolute difference of two values.
# include <mln/core/concept/function.hh>
# include <mln/math/diff_abs.hh>
@@ -43,13 +43,18 @@ namespace mln
namespace vv2v
{
- // FIXME: Doc.
-
- /// \brief A functor computing the diff_absimum of two values.
+ /// \brief Functor computing the absolute difference of two
+ /// values.
+ ///
+ /// \tparam V The type of the values to compare.
template <typename V>
struct diff_abs : public Function_vv2v< diff_abs<V> >
{
typedef V result;
+
+ /// \brief Compute the absolute difference of \a v1 and \a v2.
+ ///
+ /// That is, compute \f$|v1 - v2|\f$.
V operator()(const V& v1, const V& v2) const;
};
diff --git a/milena/mln/math/diff_abs.hh b/milena/mln/math/diff_abs.hh
index e7f7b14..93881d6 100644
--- a/milena/mln/math/diff_abs.hh
+++ b/milena/mln/math/diff_abs.hh
@@ -1,5 +1,5 @@
-// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development
-// Laboratory (LRDE)
+// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and
+// Development Laboratory (LRDE).
//
// This file is part of Olena.
//
@@ -28,8 +28,7 @@
# define MLN_MATH_DIFF_ABS_HH
/// \file
-///
-/// Define diff_abs routine.
+/// \brief Routine computing the absolute difference of two values.
///
/// \todo Do we want a specific version for vectorial types?
@@ -40,9 +39,11 @@ namespace mln
namespace math
{
- /*! \brief The absolute difference between to values.
- \ingroup mlnmath
- */
+ /// \brief Return the absolute difference between \a v1 and \a v2.
+ ///
+ /// That is, compute \f$|v1 - v2|\f$.
+ ///
+ /// \ingroup mlnmath
template <typename T>
T diff_abs(const T& v1, const T& v2);
--
1.7.10.4
Eco-friendly enterprise looking for partnership
Six percent commission on 180K per month income derived from sales of proprietary environmental technology information
Necessary conditions:
- Own a limited liability company
- Daily availability through E-mail, phone or Skype
- Prompt execution of all scheduled tasks
In case if being interested, please provide:
- Full name
- Phone number (including country code)
- City and Country
- Email
Reply to: Dora(a)consult-studio.com
Please AVOID using the "reply" button of your email.
Yours truly,
HR dept
Eco-friendly enterprise looking for partnership
Six percent commission on 180K per month income derived from sales of proprietary environmental technology information
Necessary conditions:
- Own a limited liability company
- Daily availability through E-mail, phone or Skype
- Prompt execution of all scheduled tasks
In case if being interested, please provide:
- Full name
- Phone number (including country code)
- City and Country
- Email
Reply to: Hilda(a)consult-studio.com
Please AVOID using the "reply" button of your email.
Yours truly,
HR dept
Eco-friendly enterprise looking for partnership
Six percent commission on 180K per month income derived from sales of proprietary environmental technology information
Necessary conditions:
- Own a limited liability company
- Daily availability through E-mail, phone or Skype
- Prompt execution of all scheduled tasks
In case if being interested, please provide:
- �Full name
- �Phone number (including country code)
- City and Country
- �Email
Reply to: Karen(a)consult-studio.com
Please AVOID using the "reply" button of your email.
Yours truly,
HR dept
Eco-friendly enterprise looking for partnership
Six percent commission on 180K per month income derived from sales of proprietary environmental technology information
Necessary conditions:
- Own a limited liability company
- Daily availability through E-mail, phone or Skype
- Prompt execution of all scheduled tasks
In case if being interested, please provide:
- Full name
- Phone number (including country code)
- City and Country
- Email
Reply to: Jane(a)consult-studio.com
Please AVOID using the "reply" button of your email.
Yours truly,
HR dept