DOC: Fix links to ITK Sphinx examples in class documentation

Fix links to ITK Sphinx examples in class documentation. Avoid using commas for the `ComputeMinMaxVarianceMeanOfImage` example displayed name so that the ITK Sphinx examples path/link and the displayed name parts can be parsed correctly. Fixes: ``` Modules/Core/SpatialObjects/include/itkContourSpatialObject.h:63: warning: Found unknown command '\sphinxexample' Modules/Core/SpatialObjects/include/itkContourSpatialObject.h:64: warning: Found unknown command '\endsphinx' ``` and similar warnings. Reported for example in: https://open.cdash.org/viewBuildError.php?type=1&buildid=8167118 Take advantage of the commit to fix a typo in the displayed name of one of the examples.
InsightSoftwareConsortium · Sep 23, 2022 · 29eff36 · 29eff36
1 parent 68979a9
commit 29eff36
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/Modules/Core/Common/include/itkLightObject.h b/Modules/Core/Common/include/itkLightObject.h
@@ -49,7 +49,7 @@ namespace itk
  * \ingroup ITKCommon
  *
  * \sphinx
- * \sphinx{Core/Common/GetNameOfClass, Get Name Of Class}
+ * \sphinxexample{Core/Common/GetNameOfClass,Get Name Of Class}
  * \endsphinx
  */
 class ITKCommon_EXPORT LightObject

diff --git a/Modules/Core/SpatialObjects/include/itkContourSpatialObject.h b/Modules/Core/SpatialObjects/include/itkContourSpatialObject.h
@@ -61,7 +61,7 @@ extern ITKSpatialObjects_EXPORT std::ostream &
  * \ingroup ITKSpatialObjects
  *
  * \sphinx
- * \sphinxexample{Core/SpatialObjects/{{ContourSpatialObject,Contour Spacial Object}
+ * \sphinxexample{Core/SpatialObjects/ContourSpatialObject,Contour Spatial Object}
  * \endsphinx
  */
 

diff --git a/Modules/Filtering/ImageStatistics/include/itkStatisticsImageFilter.h b/Modules/Filtering/ImageStatistics/include/itkStatisticsImageFilter.h
@@ -48,8 +48,8 @@ namespace itk
  * \ingroup ITKImageStatistics
  *
  * \sphinx
- * \sphinxexample{Filtering/ImageStatistics/ComputeMinMaxVarianceMeanOfImage,Compute Min, Max, Variance And Mean Of
- * Image} \endsphinx
+ * \sphinxexample{Filtering/ImageStatistics/ComputeMinMaxVarianceMeanOfImage,Compute Min Max Variance And Mean Of Image}
+ * \endsphinx
  */
 template <typename TInputImage>
 class ITK_TEMPLATE_EXPORT StatisticsImageFilter : public ImageSink<TInputImage>