From 22217209e5282f67238c6d3624b6d890204f85ad Mon Sep 17 00:00:00 2001
From: Guillaume Pasero <guillaume.pasero@c-s.fr>
Date: Thu, 2 Apr 2015 10:29:17 +0200
Subject: [PATCH] DOC: various doxygen fixes
---
.../include/otbImageToSURFKeyPointSetFilter.h | 18 +++++++++---------
.../SOM/include/otbSOMbasedImageFilter.h | 2 +-
.../include/otbImageToImageRCC8Calculator.txx | 4 ++--
.../include/otbImageToProfileFilter.h | 1 -
4 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/Modules/Feature/Descriptors/include/otbImageToSURFKeyPointSetFilter.h b/Modules/Feature/Descriptors/include/otbImageToSURFKeyPointSetFilter.h
index 73cc5bcd44..9531c7abac 100644
--- a/Modules/Feature/Descriptors/include/otbImageToSURFKeyPointSetFilter.h
+++ b/Modules/Feature/Descriptors/include/otbImageToSURFKeyPointSetFilter.h
@@ -145,7 +145,7 @@ protected:
/** Check local extremum for 8 neighbors (current)
*
- * \param currentScale
+ * \param neigh Current scale neighborhood
*
* \return true if the Central pixel is extremum
*/
@@ -153,8 +153,8 @@ protected:
/** Check local extremum for 8 neighbors (Previous or Scale)
*
- * \param neigh
- * \paramCenterValue
+ * \param neigh Neighborhood at previous or next scale
+ * \param CenterValue value at current scale center
*
* \return true if the Central pixel is extremum
*/
@@ -169,7 +169,7 @@ protected:
* \param currentScale iterator
* \param previousScale iterator
* \param nextScale iterator
- * \param solution
+ * \param solution refined keypoint location
*
* \return true if key point is accepted, false otherwise
*/
@@ -180,8 +180,8 @@ protected:
/** AssignOrientation
*
- * \param currentScale neighborhood
- * \param scale affected to the keypoint
+ * \param neigh current scale neighborhood
+ * \param S scale affected to the keypoint
*
* \return key point orientation
*/
@@ -190,9 +190,9 @@ protected:
/** ComputeDescriptor
*
- * \param currentScale Neighboorhood
- * \param orientation assigned to the key point
- * \param scale
+ * \param neigh current scale neighboorhood
+ * \param O orientation assigned to the key point
+ * \param S scale
*
* \return hsitogram descriptor
*/
diff --git a/Modules/Learning/SOM/include/otbSOMbasedImageFilter.h b/Modules/Learning/SOM/include/otbSOMbasedImageFilter.h
index 0c9dba7c8e..47b1fb2bb5 100644
--- a/Modules/Learning/SOM/include/otbSOMbasedImageFilter.h
+++ b/Modules/Learning/SOM/include/otbSOMbasedImageFilter.h
@@ -85,7 +85,7 @@ private:
* pixels and the winning neurons of a SOM.
*
* It performs the projection of the SOM onto the data. On the contrary to
- * \doxygen{otb}{SOMClassifier}, it does not yield labels but an image which
+ * otb::SOMClassifier, it does not yield labels but an image which
* corresponds to the quantized version of the initial image when considering
* SOMmap as a codebook of a vector quantization.
*
diff --git a/Modules/OBIA/RCC8/include/otbImageToImageRCC8Calculator.txx b/Modules/OBIA/RCC8/include/otbImageToImageRCC8Calculator.txx
index f7a5c70069..f587f49196 100644
--- a/Modules/OBIA/RCC8/include/otbImageToImageRCC8Calculator.txx
+++ b/Modules/OBIA/RCC8/include/otbImageToImageRCC8Calculator.txx
@@ -353,7 +353,7 @@ ImageToImageRCC8Calculator<TInputImage>
* process was successful.
* \param edgeEdgeBool True if edge-edge intersection is not empty.
* \param interExterBool True if interior-exterior intersection is not empty.
- * \param ExterInterBool True if exterior-interior intersection is not empty.
+ * \param exterInterBool True if exterior-interior intersection is not empty.
* \return True if the decision process was successful.
*/
template<class TInputImage>
@@ -396,7 +396,7 @@ ImageToImageRCC8Calculator<TInputImage>
/**
* Test if the boolean image is totally black or not. This is a based on the lazy operator
* paradigm.
- * \param The image to test.
+ * \param image The image to test.
* \return True or false.
*/
template<class TInputImage>
diff --git a/Modules/Segmentation/MorphologicalProfiles/include/otbImageToProfileFilter.h b/Modules/Segmentation/MorphologicalProfiles/include/otbImageToProfileFilter.h
index fc75eb56da..eef5ff4957 100644
--- a/Modules/Segmentation/MorphologicalProfiles/include/otbImageToProfileFilter.h
+++ b/Modules/Segmentation/MorphologicalProfiles/include/otbImageToProfileFilter.h
@@ -83,7 +83,6 @@ public:
protected:
/**
* Set the profile parameter
- * \param param The parameter to set
*/
virtual void SetProfileParameter(ParameterType /*param*/) {}
/** Get the pointer to the filter */
--
GitLab