From 0807842f95259ad5e629bfa5514806e076067070 Mon Sep 17 00:00:00 2001 From: Arnaud Gelas Date: Wed, 30 Mar 2011 14:56:06 -0400 Subject: [PATCH 1/2] Revert "DOC: Exclude JoinTraits* and NumericTraits* from doxygen's list of files" This reverts commit dd1edfdc459fe722f3f1facc85bd162a28f84262. --- Utilities/Doxygen/doxygen.config.in | 20 +++++--------------- 1 file changed, 5 insertions(+), 15 deletions(-) diff --git a/Utilities/Doxygen/doxygen.config.in b/Utilities/Doxygen/doxygen.config.in index 160be9f366b..e2f9273e0ec 100644 --- a/Utilities/Doxygen/doxygen.config.in +++ b/Utilities/Doxygen/doxygen.config.in @@ -638,21 +638,11 @@ RECURSIVE = YES # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = "@ITK_SOURCE_DIR@/Modules/ThirdParty/" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkPixelTraits.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraits.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsArrayPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsCovariantVectorPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsDiffusionTensor3DPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsFixedArrayPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsPointPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsRGBAPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsRGBPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsTensorPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsVariableLengthVectorPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkNumericTraitsVectorPixel.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/Common/include/itkMathDetail.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/IO/include/itkPixelData.h" \ - "@ITK_SOURCE_DIR@/Modules/Core/IO/include/itkAnalyzeDbh.h" + "@ITK_SOURCE_DIR@/Modules/Core/Common/itkPixelTraits.h" \ + "@ITK_SOURCE_DIR@/Modules/Core/Common/itkNumericTraits.h" \ + "@ITK_SOURCE_DIR@/Modules/Core/Common/itkMathDetail.h" \ + "@ITK_SOURCE_DIR@/Modules/Core/IO/itkPixelData.h" \ + "@ITK_SOURCE_DIR@/Modules/Core/IO/itkAnalyzeDbh.h" # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded From 66d825485cda3ac3333c3ed365e4947887754360 Mon Sep 17 00:00:00 2001 From: Arnaud Gelas Date: Wed, 30 Mar 2011 15:10:10 -0400 Subject: [PATCH 2/2] DOC: doxygen does not process specialization of few classes. Introduce HIDE_SPECIALIZATION_DOCUMENTATION as conditional section for doxygen. If one is interested in it, we only need to add to the list of ENABLED_SECTION in the doxygen configuration file. Here is a typical usage: /** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ template<> class MyClass< bool > {}; /** \endcond */ Change-Id: I05a563449c257e4cd3a321743c9235f50302af53 --- Modules/Core/Common/include/itkNumericTraits.h | 4 ++++ Modules/Core/Common/include/itkPixelTraits.h | 9 +++++++++ .../include/itkMorphologyHistogram.h | 3 +++ .../itkMovingHistogramMorphologicalGradientImageFilter.h | 4 ++++ Modules/Nonunit/Review/include/itkRankHistogram.h | 4 ++++ .../Statistics/include/itkMeasurementVectorTraits.h | 4 ++++ 6 files changed, 28 insertions(+) diff --git a/Modules/Core/Common/include/itkNumericTraits.h b/Modules/Core/Common/include/itkNumericTraits.h index 59da0fc51b9..76b4d26945c 100644 --- a/Modules/Core/Common/include/itkNumericTraits.h +++ b/Modules/Core/Common/include/itkNumericTraits.h @@ -125,6 +125,7 @@ class NumericTraits:public vcl_numeric_limits< T > static T min(const T & val) { return TraitsType::min(); } }; +/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ /** \class NumericTraits * \brief Define traits for type bool. @@ -678,6 +679,9 @@ class NumericTraits< unsigned long long > : static ValueType ZeroValue() { return Zero; } static ValueType OneValue() { return One; } }; + +/** \endcond */ + } // end namespace itk #include "itkFixedArray.h" diff --git a/Modules/Core/Common/include/itkPixelTraits.h b/Modules/Core/Common/include/itkPixelTraits.h index 1a17deabf19..fa40a31416a 100644 --- a/Modules/Core/Common/include/itkPixelTraits.h +++ b/Modules/Core/Common/include/itkPixelTraits.h @@ -51,6 +51,8 @@ class PixelTraits typedef typename TPixelType::ValueType ValueType; }; +/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ + /** \class PixelTraits * Specialization of PixelTraits for scalar images. */ template< > @@ -149,6 +151,8 @@ class PixelTraits< double > typedef double ValueType; }; +/** \endcond */ + /** \class JoinTraits * \brief Trait to determine what datatype is needed if the specified * pixel types are "joined" into a single vector. @@ -173,6 +177,8 @@ class JoinTraits typedef TValueType1 ValueType; }; +/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ + /** \class JoinTraits * Specializations for bool. */ template< > @@ -1047,6 +1053,9 @@ class JoinTraits< double, double > public: typedef double ValueType; }; + +/** \endcond */ + } // end namespace itk #endif // __itkPixelTraits_h diff --git a/Modules/Filtering/MathematicalMorphology/include/itkMorphologyHistogram.h b/Modules/Filtering/MathematicalMorphology/include/itkMorphologyHistogram.h index 931c32ca412..a409fa8c964 100644 --- a/Modules/Filtering/MathematicalMorphology/include/itkMorphologyHistogram.h +++ b/Modules/Filtering/MathematicalMorphology/include/itkMorphologyHistogram.h @@ -189,6 +189,7 @@ class VectorMorphologyHistogram TInputPixel m_Boundary; }; +/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ // now create MorphologyHistogram partial specilizations using the VectorMorphologyHistogram // as base class @@ -211,6 +212,8 @@ class MorphologyHistogram: { }; +/** \endcond */ + } // end namespace Function } // end namespace itk diff --git a/Modules/Filtering/MathematicalMorphology/include/itkMovingHistogramMorphologicalGradientImageFilter.h b/Modules/Filtering/MathematicalMorphology/include/itkMovingHistogramMorphologicalGradientImageFilter.h index 1bab91cd09a..75efb2561a4 100644 --- a/Modules/Filtering/MathematicalMorphology/include/itkMovingHistogramMorphologicalGradientImageFilter.h +++ b/Modules/Filtering/MathematicalMorphology/include/itkMovingHistogramMorphologicalGradientImageFilter.h @@ -179,6 +179,8 @@ class VectorMorphologicalGradientHistogram SizeValueType m_Count; }; +/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ + // now create MorphologicalGradientHistogram specilizations using the VectorMorphologicalGradientHistogram // as base class @@ -200,6 +202,8 @@ class MorphologicalGradientHistogram: { }; +/** \endcond */ + } // end namespace Function /** diff --git a/Modules/Nonunit/Review/include/itkRankHistogram.h b/Modules/Nonunit/Review/include/itkRankHistogram.h index 65ef26c13e6..ed8c33d5402 100644 --- a/Modules/Nonunit/Review/include/itkRankHistogram.h +++ b/Modules/Nonunit/Review/include/itkRankHistogram.h @@ -389,6 +389,8 @@ class VectorRankHistogram // now create MorphologicalGradientHistogram specilizations using the VectorMorphologicalGradientHistogram // as base class +/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ + template<> class RankHistogram: public VectorRankHistogram @@ -407,6 +409,8 @@ class RankHistogram: { }; +/** \endcond */ + } // end namespace Function } // end namespace itk #endif diff --git a/Modules/Numerics/Statistics/include/itkMeasurementVectorTraits.h b/Modules/Numerics/Statistics/include/itkMeasurementVectorTraits.h index 27b91f005f4..0edc6f6239a 100644 --- a/Modules/Numerics/Statistics/include/itkMeasurementVectorTraits.h +++ b/Modules/Numerics/Statistics/include/itkMeasurementVectorTraits.h @@ -443,6 +443,7 @@ class MeasurementVectorPixelTraits typedef TPixelType MeasurementVectorType; }; +/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */ template< > class MeasurementVectorPixelTraits< char > { @@ -519,6 +520,9 @@ class MeasurementVectorPixelTraits< double > public: typedef FixedArray< double, 1 > MeasurementVectorType; }; + +/** \endcond*/ + } // namespace Statistics } // namespace itk