Merge topic 'DoxSkipSpecialization'

66d8254 DOC: doxygen does not process specialization of few classes. 0807842 Revert "DOC: Exclude JoinTraits* and NumericTraits* from doxygen's list of files"
Kitware · Mar 30, 2011 · 7a8f29f · 7a8f29f
2 parents 1e6d9e3 + 66d8254
commit 7a8f29f
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 15 deletions.
diff --git 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<bool>
  * \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
@@ -51,6 +51,8 @@ class PixelTraits
   typedef typename TPixelType::ValueType ValueType;
 };
 
+/** \cond HIDE_SPECIALIZATION_DOCUMENTATION */
+
 /** \class PixelTraits<bool>
  * 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
@@ -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<bool, TCompare>:
 {
 };
 
+/** \endcond */
+
 } // end namespace Function
 } // end namespace itk
 

diff --git a/...ering/MathematicalMorphology/include/itkMovingHistogramMorphologicalGradientImageFilter.h b/...ering/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<bool>:
 {
 };
 
+/** \endcond */
+
 } // end namespace Function
 
 /**

diff --git 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<unsigned char>:
   public VectorRankHistogram<unsigned char>
@@ -407,6 +409,8 @@ class RankHistogram<bool>:
 {
 };
 
+/** \endcond */
+
 } // end namespace Function
 } // end namespace itk
 #endif
diff --git 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
 

diff --git 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