Commit 22217209 authored by Guillaume Pasero's avatar Guillaume Pasero
Browse files

DOC: various doxygen fixes

parent 60e4e46e
...@@ -145,7 +145,7 @@ protected: ...@@ -145,7 +145,7 @@ protected:
/** Check local extremum for 8 neighbors (current) /** Check local extremum for 8 neighbors (current)
* *
* \param currentScale * \param neigh Current scale neighborhood
* *
* \return true if the Central pixel is extremum * \return true if the Central pixel is extremum
*/ */
...@@ -153,8 +153,8 @@ protected: ...@@ -153,8 +153,8 @@ protected:
/** Check local extremum for 8 neighbors (Previous or Scale) /** Check local extremum for 8 neighbors (Previous or Scale)
* *
* \param neigh * \param neigh Neighborhood at previous or next scale
* \paramCenterValue * \param CenterValue value at current scale center
* *
* \return true if the Central pixel is extremum * \return true if the Central pixel is extremum
*/ */
...@@ -169,7 +169,7 @@ protected: ...@@ -169,7 +169,7 @@ protected:
* \param currentScale iterator * \param currentScale iterator
* \param previousScale iterator * \param previousScale iterator
* \param nextScale iterator * \param nextScale iterator
* \param solution * \param solution refined keypoint location
* *
* \return true if key point is accepted, false otherwise * \return true if key point is accepted, false otherwise
*/ */
...@@ -180,8 +180,8 @@ protected: ...@@ -180,8 +180,8 @@ protected:
/** AssignOrientation /** AssignOrientation
* *
* \param currentScale neighborhood * \param neigh current scale neighborhood
* \param scale affected to the keypoint * \param S scale affected to the keypoint
* *
* \return key point orientation * \return key point orientation
*/ */
...@@ -190,9 +190,9 @@ protected: ...@@ -190,9 +190,9 @@ protected:
/** ComputeDescriptor /** ComputeDescriptor
* *
* \param currentScale Neighboorhood * \param neigh current scale neighboorhood
* \param orientation assigned to the key point * \param O orientation assigned to the key point
* \param scale * \param S scale
* *
* \return hsitogram descriptor * \return hsitogram descriptor
*/ */
......
...@@ -85,7 +85,7 @@ private: ...@@ -85,7 +85,7 @@ private:
* pixels and the winning neurons of a SOM. * pixels and the winning neurons of a SOM.
* *
* It performs the projection of the SOM onto the data. On the contrary to * 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 * corresponds to the quantized version of the initial image when considering
* SOMmap as a codebook of a vector quantization. * SOMmap as a codebook of a vector quantization.
* *
......
...@@ -353,7 +353,7 @@ ImageToImageRCC8Calculator<TInputImage> ...@@ -353,7 +353,7 @@ ImageToImageRCC8Calculator<TInputImage>
* process was successful. * process was successful.
* \param edgeEdgeBool True if edge-edge intersection is not empty. * \param edgeEdgeBool True if edge-edge intersection is not empty.
* \param interExterBool True if interior-exterior 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. * \return True if the decision process was successful.
*/ */
template<class TInputImage> template<class TInputImage>
...@@ -396,7 +396,7 @@ ImageToImageRCC8Calculator<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 * Test if the boolean image is totally black or not. This is a based on the lazy operator
* paradigm. * paradigm.
* \param The image to test. * \param image The image to test.
* \return True or false. * \return True or false.
*/ */
template<class TInputImage> template<class TInputImage>
......
...@@ -83,7 +83,6 @@ public: ...@@ -83,7 +83,6 @@ public:
protected: protected:
/** /**
* Set the profile parameter * Set the profile parameter
* \param param The parameter to set
*/ */
virtual void SetProfileParameter(ParameterType /*param*/) {} virtual void SetProfileParameter(ParameterType /*param*/) {}
/** Get the pointer to the filter */ /** Get the pointer to the filter */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment