* sandbox/abraham/mln/transform/fft.hh,
* sandbox/nivault/dmap.hh:
Here.
---
milena/sandbox/ChangeLog | 8 +++++
milena/sandbox/abraham/mln/transform/fft.hh | 38 +++++++++++++-------------
milena/sandbox/nivault/dmap.hh | 4 +-
3 files changed, 29 insertions(+), 21 deletions(-)
diff --git a/milena/sandbox/ChangeLog b/milena/sandbox/ChangeLog
index 8944cde..b99bf5b 100644
--- a/milena/sandbox/ChangeLog
+++ b/milena/sandbox/ChangeLog
@@ -1,3 +1,11 @@
+2009-06-09 Roland Levillain <roland(a)lrde.epita.fr>
+
+ Stop using \arg instead of \param or \tparam in documentation.
+
+ * sandbox/abraham/mln/transform/fft.hh,
+ * sandbox/nivault/dmap.hh:
+ Here.
+
2009-06-10 Fabien Freling <fabien.freling(a)lrde.epita.fr>
Add new distance and minor updates.
diff --git a/milena/sandbox/abraham/mln/transform/fft.hh
b/milena/sandbox/abraham/mln/transform/fft.hh
index 8fc5a23..0dafa7b 100644
--- a/milena/sandbox/abraham/mln/transform/fft.hh
+++ b/milena/sandbox/abraham/mln/transform/fft.hh
@@ -103,9 +103,9 @@ namespace mln {
** For each point p of the transformed image T, you get
** |T[p]|.
**
- ** \param R Data type of the resulting image.
+ ** \tparam R Data type of the resulting image.
**
- ** \arg ordered Kind of traversal.
+ ** \param ordered Kind of traversal.
*/
template <class R>
image2d<R> transformed_image_magn(bool ordered = true) const
@@ -137,7 +137,7 @@ namespace mln {
** For each point p of the transformed image T, you get
** |T[p]|.
**
- ** \arg ordered Kind of traversal.
+ ** \param ordered Kind of traversal.
*/
image2d<T> transformed_image_magn(bool ordered = true) const
{
@@ -152,8 +152,8 @@ namespace mln {
**
** \param R Data type of the resulting image.
**
- ** \arg clip Value used for clipping.
- ** \arg ordered Kind of traversal.
+ ** \param clip Value used for clipping.
+ ** \param ordered Kind of traversal.
*/
template <class R>
@@ -207,8 +207,8 @@ namespace mln {
** For each point p of the transformed image T, you get
** a clipped value of |T[p]|.\n
**
- ** \arg clip Value used for clipping.
- ** \arg ordered Kind of traversal.
+ ** \param clip Value used for clipping.
+ ** \param ordered Kind of traversal.
*/
image2d<T> transformed_image_clipped_magn(const double clip,
bool ordered = true) const
@@ -224,7 +224,7 @@ namespace mln {
**
** \param R Data type of the resulting image.
**
- ** \arg ordered Kind of traversal.
+ ** \param ordered Kind of traversal.
*/
image2d<T> transformed_image_clipped_magn(bool ordered = true) const
@@ -240,7 +240,7 @@ namespace mln {
**
** \param R Data type of the resulting image.
**
- ** \arg ordered Kind of traversal.
+ ** \param ordered Kind of traversal.
*/
template <class R>
@@ -256,9 +256,9 @@ namespace mln {
** For each point p of the transformed image T, you get
** a log translated value of |T[p]| on interval [a; b].\n
**
- ** \arg a Lower bound.
- ** \arg b Upper bound.
- ** \arg ordered Kind of traversal.
+ ** \param a Lower bound.
+ ** \param b Upper bound.
+ ** \param ordered Kind of traversal.
*/
template <class R>
@@ -306,9 +306,9 @@ namespace mln {
** For each point p of the transformed image T, you get
** a log translated value of |T[p]| on interval [a; b].\n
**
- ** \arg a Lower bound.
- ** \arg b Upper bound.
- ** \arg ordered Kind of traversal.
+ ** \param a Lower bound.
+ ** \param b Upper bound.
+ ** \param ordered Kind of traversal.
*/
image2d<T> transformed_image_log_magn(double a,
@@ -326,7 +326,7 @@ namespace mln {
**
** \param R Data type of the resulting image.
**
- ** \arg ordered Kind of traversal.
+ ** \param ordered Kind of traversal.
*/
template <class R>
@@ -341,7 +341,7 @@ namespace mln {
** For each point p of the transformed image T, you get
** a log translated value of |T[p]| on interval [1; 100].\n
**
- ** \arg ordered Kind of traversal.
+ ** \param ordered Kind of traversal.
*/
image2d<T> transformed_image_log_magn(bool ordered = true) const
@@ -403,7 +403,7 @@ namespace mln {
**
** Initialization of data in order to compute the fft.
**
- ** \arg original_im Image to process.
+ ** \param original_im Image to process.
*/
template <typename D>
fft(const image2d<D>& original_im)
@@ -599,7 +599,7 @@ namespace mln {
**
** Initialization of data in order to compute the fft.
**
- ** \arg original_im Image to process.
+ ** \param original_im Image to process.
*/
fft(const image2d< std::complex<T> >& original_im)
{
diff --git a/milena/sandbox/nivault/dmap.hh b/milena/sandbox/nivault/dmap.hh
index d6cea9b..625be08 100644
--- a/milena/sandbox/nivault/dmap.hh
+++ b/milena/sandbox/nivault/dmap.hh
@@ -525,8 +525,8 @@ namespace oln {
/*! Constructor.
**
- ** \arg size Size of the image on which the dmap will be compute.
- ** \arg ch Chamfer distance used.
+ ** \param size Size of the image on which the dmap will be compute.
+ ** \param ch Chamfer distance used.
*/
dmap(const image2d_size& size, const chamfer<T2>& ch);
--
1.6.1.2
Show replies by date