Commit 2c970180 authored by Julien Michel's avatar Julien Michel

DOC: Fixing group in documentation

parent 1ca37061
......@@ -28,7 +28,7 @@
/** \class CommandLineArgumentParserHelpException
* \brief This exception is thrown when the help menu is displayed.
*
* \ingroup OTBCommon
* \ingroup OTBCommandLineParser
*/
class ITK_EXPORT CommandLineArgumentParserHelpException
: public itk::ExceptionObject
......@@ -52,7 +52,7 @@ public:
/** \class CommandLineArgumentParserVersionException
* \brief This exception is thrown when the version is displayed.
*
* \ingroup OTBCommon
* \ingroup OTBCommandLineParser
*/
class ITK_EXPORT CommandLineArgumentParserVersionException
: public itk::ExceptionObject
......@@ -76,7 +76,7 @@ public:
/** \class CommandLineArgumentParserArgumentErrorException
* \brief This exception is thrown when the version is displayed.
*
* \ingroup OTBCommon
* \ingroup OTBCommandLineParser
*/
class ITK_EXPORT CommandLineArgumentParserArgumentErrorException
: public itk::ExceptionObject
......@@ -108,7 +108,7 @@ namespace otb
*
* \see CommandLineArgumentParser
*
* \ingroup OTBCommon
* \ingroup OTBCommandLineParser
*/
class ITK_EXPORT CommandLineArgumentParseResult : public itk::ProcessObject
{
......@@ -210,7 +210,7 @@ private:
* }
* \endcode
*
* \ingroup OTBCommon
* \ingroup OTBCommandLineParser
*/
class ITK_EXPORT CommandLineArgumentParser : public itk::ProcessObject
{
......
......@@ -41,7 +41,7 @@ namespace Functor
* and itk::ComplexToPhaseImageFilter for example.
*
*
* \ingroup OTBColorMap
* \ingroup OTBComplexImage
*/
template<class TInput1, class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
class ITK_EXPORT AmplitudePhaseToRGBFunctor
......
......@@ -48,7 +48,7 @@ namespace otb
*
* \sa VectorDataExtractROI
*
* \ingroup OTBVectorDataBase
* \ingroup OTBImageBase
*/
template <class TType>
......
......@@ -42,7 +42,7 @@ namespace Functor
* \sa BandsStatisticsAttributesLabelMapFilter
* \sa StatisticsAttributesLabelObjectFunctor
*
* \ingroup OTBStatistics
* \ingroup OTBLabelMap
*/
template <class TLabelObject, class TFeatureImage>
class BandStatsAttributesLabelObjectFunctor
......@@ -130,7 +130,7 @@ private:
*
* \ingroup ImageEnhancement MathematicalMorphologyImageFilters
*
* \ingroup OTBStatistics
* \ingroup OTBLabelMap
*/
template<class TImage, class TFeatureImage>
class ITK_EXPORT BandsStatisticsAttributesLabelMapFilter
......
......@@ -39,7 +39,7 @@ namespace otb
*
* It is suitable to be used with otb::LabelMapWithAdjacency<otb::AttributesMapLabelObject>
*
* \ingroup OTBMoments
* \ingroup OTBLabelMap
*/
template <class TInputImage, class TLabeledImage, class TLabel, class TLabelObject >
class ITK_EXPORT ImageToLabelMapWithAttributesFilter
......
......@@ -39,7 +39,7 @@ namespace Functor
*
* \sa ShapeAttributesLabelMapFilter
*
* \ingroup OTBMoments
* \ingroup OTBLabelMap
*/
template <class TLabelObject, class TLabelImage>
class ShapeAttributesLabelObjectFunctor
......@@ -199,7 +199,7 @@ private:
*
* \ingroup ImageEnhancement MathematicalMorphologyImageFilters
*
* \ingroup OTBMoments
* \ingroup OTBLabelMap
*/
template<class TImage,
class TLabelImage = Image<typename TImage::PixelType,
......
......@@ -30,7 +30,7 @@ namespace otb
* \ingroup Images
* \ingroup Lists
*
* \ingroup OTBImageManipulation
* \ingroup OTBObjectList
*/
template <class TInputImage, class TOutputImage>
class ITK_EXPORT ImageToImageListFilter
......
......@@ -35,7 +35,7 @@ namespace otb
*
* \ingroup Streamed
*
* \ingroup OTBImageManipulation
* \ingroup OTBObjectList
*/
template <class TVectorImageType, class TImageList>
class ITK_EXPORT VectorImageToImageListFilter
......
......@@ -38,7 +38,7 @@ namespace otb
* \sa LogPolarTransform
* \ingroup Transform
*
* \ingroup OTBImageManipulation
* \ingroup OTBTransform
*/
template <class TScalarType>
......
......@@ -29,7 +29,7 @@ namespace otb
* \example FeatureExtraction/ExtractRoadByStepsExample.cxx
*
*
* \ingroup OTBPath
* \ingroup OTBRoadExtraction
*/
template <class TPath>
class ITK_EXPORT BreakAngularPathListFilter
......
......@@ -27,7 +27,7 @@ namespace otb
/** \class FillGapsFilter
* \brief To be documented
*
* \ingroup OTBSpatialObjects
* \ingroup OTBEdge
*/
class ITK_EXPORT FillGapsFilter : public itk::ProcessObject
{
......
......@@ -53,7 +53,7 @@ namespace otb
* \ingroup PathFilters
* \ingroup ImageFilters
*
* \ingroup OTBPath
* \ingroup OTBSeamCarving
*/
template <class TInputImage, class TInputPath, class TOutputImage>
......
......@@ -65,7 +65,7 @@ namespace otb
* - \f$ \phi \f$ : Phase of the sinusoidal carrier (GetPhi()/SetPhi())
*
*
* \ingroup OTBEdge
* \ingroup OTBConvolution
*/
template <class TPrecision>
......
......@@ -49,7 +49,7 @@ namespace otb
* \ingroup DEMToImageGenerator
* \ingroup Radiometry
*
* \ingroup OTBStatistics
* \ingroup OTBDEM
*/
template <class TInputImage, class TOutputImage>
class ITK_EXPORT DEMCaracteristicsExtractor :
......
......@@ -42,7 +42,7 @@ namespace otb
* \example IO/DEMToImageGenerator.cxx
*
*
* \ingroup OTBImageManipulation
* \ingroup OTBDEM
*/
template <class TDEMImage>
class ITK_EXPORT DEMToImageGenerator :
......
......@@ -30,7 +30,7 @@ namespace Functor
/** \class LocalActivityOperator
* \brief Performs the calculation of LocalActivity derivation
*
* \ingroup OTBImageManipulation
* \ingroup OTBDimensionalityReduction
*/
template < class TInput, class TOutput >
class LocalActivityOperator
......@@ -79,7 +79,7 @@ public:
/** \class LocalActivityVectorImageFilter
* \brief Implements the LocalActivity Gradient to be processed on a vector image
*
* \ingroup OTBImageManipulation
* \ingroup OTBDimensionalityReduction
*/
template < class TInputImage, class TOutputImage >
class ITK_EXPORT LocalActivityVectorImageFilter
......
......@@ -41,7 +41,7 @@ namespace Statistics {
* \sa EuclideanDistanceMetric
* \sa EuclideanDistanceMetricWithMissingValuePow2
*
* \ingroup OTBImageBase
* \ingroup OTBImageManipulation
*/
template<class TVector>
class ITK_EXPORT EuclideanDistanceMetricWithMissingValue :
......
......@@ -43,7 +43,7 @@ namespace Statistics {
* \sa EuclideanDistanceMetric
* \sa EuclideanDistanceMetricWithMissingValue
*
* \ingroup OTBImageBase
* \ingroup OTBImageManipulation
*/
template<class TVector>
class ITK_EXPORT EuclideanDistanceMetricWithMissingValuePow2 :
......
......@@ -46,7 +46,7 @@ namespace Statistics {
*
* \sa EuclideanDistanceMetricWithMissingValuePow2
*
* \ingroup OTBImageBase
* \ingroup OTBImageManipulation
*/
template<class TVector>
class ITK_EXPORT FlexibleDistanceWithMissingValue :
......
......@@ -56,7 +56,7 @@ namespace otb
* \ingroup Streamed
* \ingroup Threaded
*
* \ingroup OTBMathParser
* \ingroup OTBMathParserX
*/
template< class TImage >
......
......@@ -35,7 +35,7 @@ class ParserXImpl;
* \sa BandMathImageFilter
*
*
* \ingroup OTBMathParser
* \ingroup OTBMathParserX
*/
class ITK_EXPORT ParserX : public itk::LightObject
{
......
......@@ -32,7 +32,7 @@ namespace Functor
*
* \sa otbSavitzkyGolayInterpolationFunctor
*
* \ingroup OTBSmoothing
* \ingroup OTBTimeSeries
*/
template <unsigned int Radius, class TSeries, class TDates, class TWeight = TSeries>
class EnvelopeSavitzkyGolayInterpolationFunctor
......
......@@ -48,7 +48,7 @@ namespace Functor
* \sa otbTimeSeriesLeastSquareFittingFunctor
*
*
* \ingroup OTBSmoothing
* \ingroup OTBTimeSeries
*/
template <unsigned int Radius, class TSeries, class TDates, class TWeight = TSeries, unsigned int Degree=2>
class SavitzkyGolayInterpolationFunctor
......
......@@ -50,7 +50,7 @@ namespace Functor
*
*
*
* \ingroup OTBSmoothing
* \ingroup OTBTimeSeries
*/
template <class TSeriesType, class TTimeFunction, class TDateType = TSeriesType, class TWeightType = TSeriesType>
class TimeSeriesLeastSquareFittingFunctor
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class BoostMachineLearningModelFactory
* \brief Creation d'un instance d'un objet SVMMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT BoostMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class DecisionTreeMachineLearningModelFactory
* \brief Creation d'un instance d'un objet SVMMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT DecisionTreeMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class GradientBoostedTreeMachineLearningModelFactory
* \brief Creation d'un instance d'un objet SVMMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT GradientBoostedTreeMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class KNearestNeighborsMachineLearningModelFactory
* \brief Creation d'un instance d'un objet KNearestNeighborsMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT KNearestNeighborsMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -26,7 +26,7 @@ namespace otb
/** \class LibSVMMachineLearningModelFactory
* \brief Creation d'un instance d'un objet SVMMachineLearningModel utilisant les object factory.
*
* \ingroup OTBSVMLearning
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT LibSVMMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class NeuralNetworkMachineLearningModelFactory
* \brief Creation d'un instance d'un objet SVMMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT NeuralNetworkMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class NormalBayesMachineLearningModelFactory
* \brief Creation d'un instance d'un objet SVMMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT NormalBayesMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class RandomForestsMachineLearningModelFactory
* \brief Creation d'un instance d'un objet RandomForestsMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT RandomForestsMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -28,7 +28,7 @@ namespace otb
/** \class SVMMachineLearningModelFactory
* \brief Creation d'un instance d'un objet SVMMachineLearningModel utilisant les object factory.
*
* \ingroup OTBOpenCVAdapters
* \ingroup OTBSupervised
*/
template <class TInputValue, class TTargetValue>
class ITK_EXPORT SVMMachineLearningModelFactory : public itk::ObjectFactoryBase
......
......@@ -53,7 +53,7 @@ namespace LandsatTM
* \ingroup Radiometry
* \ingroup LandsatTMIndices
*
* \ingroup OTBOpticalCalibration
* \ingroup OTBLandSatClassifier
*/
template <class TInput, class TOutput>
class SpectralRuleBasedClassifier : public KernelSpectralRule<TInput, TOutput>
......
......@@ -65,7 +65,7 @@ namespace otb
* \sa FastCorrelationImageFilter, DisparityMapEstimationMethod
* \ingroup IntensityImageFilters, Streamed
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template <class TInputImage, class T0utputCorrelation, class TOutputDisplacementField>
class ITK_EXPORT FineRegistrationImageFilter : public itk::ImageToImageFilter<TInputImage, T0utputCorrelation>
......
......@@ -63,7 +63,7 @@ namespace otb
*
*
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template<class TFixedImage, class TMovingImage, class TDisplacementField>
class ITK_EXPORT NCCRegistrationFilter :
......
......@@ -42,7 +42,7 @@ namespace otb
* \sa itk::NCCRegistrationFunction
* \ingroup FiniteDifferenceFunctions
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template<class TFixedImage, class TMovingImage, class TDisplacementField>
class ITK_EXPORT NCCRegistrationFunction :
......
......@@ -38,7 +38,7 @@ namespace Functor
* templated by the type of inputs images and output metric image,
* and is using two neighborhood iterators as inputs.
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template <class TInputImage, class TOutputMetricImage>
ITK_EXPORT class SSDBlockMatching
......@@ -72,7 +72,7 @@ public:
* templated by the type of inputs images and output metric image,
* and is using two neighborhood iterators as inputs.
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template <class TInputImage, class TOutputMetricImage>
ITK_EXPORT class SSDDivMeanBlockMatching
......@@ -117,7 +117,7 @@ public:
* templated by the type of inputs images and output metric image,
* and is using two neighborhood iterators as inputs.
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template <class TInputImage, class TOutputMetricImage>
ITK_EXPORT class NCCBlockMatching
......@@ -187,7 +187,7 @@ public:
* templated by the type of inputs images and output metric image,
* and is using two neighborhood iterators as inputs.
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template <class TInputImage, class TOutputMetricImage>
ITK_EXPORT class LPBlockMatching
......@@ -289,7 +289,7 @@ private:
* \ingroup Threaded
*
*
* \ingroup OTBStereo
* \ingroup OTBDisparityMap
*/
template <class TInputImage, class TOutputMetricImage, class TOutputDisparityImage = TOutputMetricImage, class TMaskImage = otb::Image<unsigned char>,
......
......@@ -81,7 +81,7 @@ namespace otb
* \sa StreamingWarpImageFilter
* \sa StereoSensorModelToElevationMapFilter
*
* \ingroup OTBDisplacementField
* \ingroup OTBStereo
*/
template <class TInputImage, class TOutputImage >
class ITK_EXPORT StereorectificationDisplacementFieldSource
......
......@@ -19,6 +19,8 @@ struct svm_parameter;
/** \class GenericKernelFunctorBase
* \brief Undocumented
*
* \ingroup OTBLibSVM
*/
class GenericKernelFunctorBase
{
......@@ -99,6 +101,8 @@ private:
/** \class ComposedKernelFunctor
* \brief Undocumented
*
* \ingroup OTBLibSVM
*/
class ComposedKernelFunctor: public GenericKernelFunctorBase
{
......
......@@ -32,7 +32,6 @@ namespace otb
*
* \ingroup OTBQtWidget
*
* \ingroup OTBQtWidget
*/
class ITK_ABI_EXPORT QtLogOutput : public QObject, public itk::LogOutput
......
......@@ -36,7 +36,6 @@ class QtWidgetParameterBase;
*
* \ingroup OTBQtWidget
*
* \ingroup OTBQtWidget
*/
class ITK_ABI_EXPORT QtWidgetParameterFactory : public itk::Object
{
......
......@@ -38,6 +38,8 @@ namespace itk
* This is analogous to itk::TclCommand, but then a tad more flexible.; )
*
* This class was contributed by Charl P. Botha <cpbotha |AT| ieee.org>
*
* \ingroup OTBSWIG
*/
class PyCommand : public Command
{
......
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