From e9aafe6011a1b23d343c493315e7dd7e9ee6d88d Mon Sep 17 00:00:00 2001 From: Emmanuel Christophe <emmanuel.christophe@orfeo-toolbox.org> Date: Thu, 15 Oct 2009 10:27:12 +0800 Subject: [PATCH] DOC: fix doxygen errors --- Code/BasicFilters/otbBoxAndWhiskerImageFilter.h | 6 +++--- Code/BasicFilters/otbEuclideanDistanceWithMissingValue.h | 2 +- .../BasicFilters/otbEuclideanDistanceWithMissingValuePow2.h | 6 +++--- Code/BasicFilters/otbFlexibleDistanceWithMissingValue.h | 2 +- Code/Common/otbVectorDataToImageFilter.h | 4 ++-- Code/MultiScale/otbWaveletPacketTransform.h | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Code/BasicFilters/otbBoxAndWhiskerImageFilter.h b/Code/BasicFilters/otbBoxAndWhiskerImageFilter.h index 7f79abdaa2..362047f511 100644 --- a/Code/BasicFilters/otbBoxAndWhiskerImageFilter.h +++ b/Code/BasicFilters/otbBoxAndWhiskerImageFilter.h @@ -32,12 +32,12 @@ namespace otb { * This is appropriated to perform simple outlier detection over vector data. * The input image has to contain vector pixel through a VectorImage type. * When an outlier is detected, it is treated to as an missing value through the function - * \code{otb::EuclideanDistanceWithMissingValue::SetToMissingValue()}. + * \code otb::EuclideanDistanceWithMissingValue::SetToMissingValue() \endcode. * * A component is considered to as a missing value when * \f$ \| x_i - \beta \left( x_{3/4} - x_{1/4} \right) \| > \| x_{1/2} \| \f$ * where \f$ x_{1/4}, x_{1/2}, x_{3/4} \f$ stand for the first, second (median) and - * thrid quantile values. + * third quantile values. * * \ingroup Streamed * \sa EuclideanDistanceWithMissingValue @@ -83,7 +83,7 @@ class ITK_EXPORT BoxAndWhiskerImageFilter /** Get the Radius (all to 1) */ itkGetConstReferenceMacro(Radius, SizeType); - /** Fix the \em whisker */ + /** Fix the whisker */ itkGetConstMacro(Beta,double); itkSetMacro(Beta,double); itkGetConstMacro(NumberFound,unsigned int); diff --git a/Code/BasicFilters/otbEuclideanDistanceWithMissingValue.h b/Code/BasicFilters/otbEuclideanDistanceWithMissingValue.h index d1746c8cba..1fa9b5f595 100644 --- a/Code/BasicFilters/otbEuclideanDistanceWithMissingValue.h +++ b/Code/BasicFilters/otbEuclideanDistanceWithMissingValue.h @@ -36,7 +36,7 @@ namespace Statistics { * The class can be templated over any container that holds data elements, as * for template of EuclideanDistance. * - * The only restriction is that elemnts have to support '\code{NaN}'. + * The only restriction is that elements have to support NaN values. * * \sa EuclideanDistance * \sa EuclideanDistanceWithMissingValuePow2 diff --git a/Code/BasicFilters/otbEuclideanDistanceWithMissingValuePow2.h b/Code/BasicFilters/otbEuclideanDistanceWithMissingValuePow2.h index 5e79e38858..9947f57f76 100644 --- a/Code/BasicFilters/otbEuclideanDistanceWithMissingValuePow2.h +++ b/Code/BasicFilters/otbEuclideanDistanceWithMissingValuePow2.h @@ -32,13 +32,13 @@ namespace Statistics { * * This class is derived from EuclideanDistance class. In addition * to the initial Evaluate method, the class does not perform calculation - * when a component does not contain any data. The 'no data' case is perform through the \code{SetToMissingValue()} - * which performs a \code{Nan} affectation. + * when a component does not contain any data. The 'no data' case is perform through the \code SetToMissingValue() \endcode + * which performs a \code Nan \endcode affectation. * * The class can be templated over any container that holds data elements, as * for template of EuclideanDistance. * - * The only restriction is that elemnts have to support '\code{NaN}'. + * The only restriction is that elements have to support NaN values. * * \sa EuclideanDistance * \sa EuclideanDistanceWithMissingValue diff --git a/Code/BasicFilters/otbFlexibleDistanceWithMissingValue.h b/Code/BasicFilters/otbFlexibleDistanceWithMissingValue.h index 5739da2039..5fd88f17ab 100644 --- a/Code/BasicFilters/otbFlexibleDistanceWithMissingValue.h +++ b/Code/BasicFilters/otbFlexibleDistanceWithMissingValue.h @@ -42,7 +42,7 @@ namespace Statistics { * The class can be templated over any container that holds data elements, as * for template of EuclideanDistance. * - * The only restriction is that elements have to support '\code{NaN}'. + * The only restriction is that elements have to support \code NaN \endcode. * * \sa EuclideanDistanceWithMissingValuePow2 */ diff --git a/Code/Common/otbVectorDataToImageFilter.h b/Code/Common/otbVectorDataToImageFilter.h index afc5d0025d..5dad366b2e 100644 --- a/Code/Common/otbVectorDataToImageFilter.h +++ b/Code/Common/otbVectorDataToImageFilter.h @@ -134,7 +134,7 @@ template <class TVectorData, class TImage> */ itkSetMacro(UseAsOverlay, bool); itkGetMacro(UseAsOverlay, bool); - itkBooleanMacro(UseAsOverlay) + itkBooleanMacro(UseAsOverlay); protected: /** Constructor */ @@ -191,4 +191,4 @@ template <class TVectorData, class TImage> #include "otbVectorDataToImageFilter.txx" #endif -#endif \ No newline at end of file +#endif diff --git a/Code/MultiScale/otbWaveletPacketTransform.h b/Code/MultiScale/otbWaveletPacketTransform.h index a84fc5d899..87072da8bc 100644 --- a/Code/MultiScale/otbWaveletPacketTransform.h +++ b/Code/MultiScale/otbWaveletPacketTransform.h @@ -85,7 +85,7 @@ private: void operator= ( const Self & ); }; -/** \class Wavelet Packet Transform +/** \class WaveletPacketTransform * \brief Wavelet packet forward transformation framework * * This class defines the Wavelet Packet transformation of an image @@ -215,7 +215,7 @@ private: }; // end of class -/** \class Wavelet Packet Transform +/** \class WaveletPacketTransform * \brief Wavelet packet inverse transformation framework * * This class defines the Wavelet Packet transformation of an image -- GitLab