DOC: Clean up method Doxygen documentation

Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.h

@@ -69,7 +69,9 @@ class ITK_TEMPLATE_EXPORT ImageToVTKImageFilter : public ProcessObject
   using ExporterFilterPointer = typename ExporterFilterType::Pointer;
 
   /** Get the output in the form of a vtkImage.
-      This call is delegated to the internal vtkImageImport filter  */
+   *
+   * This call is delegated to the internal vtkImageImport filter.
+   */
   vtkImageData *
   GetOutput() const;
 
@@ -81,22 +83,24 @@ class ITK_TEMPLATE_EXPORT ImageToVTKImageFilter : public ProcessObject
   GetInput();
 
   /** Return the internal VTK image importer filter.
-      This is intended to facilitate users the access
-      to methods in the importer */
+   *
+   * Intended to facilitate users the access to methods in the importer.
+   */
   vtkImageImport *
   GetImporter() const;
 
   /** Return the internal ITK image exporter filter.
-      This is intended to facilitate users the access
-      to methods in the exporter */
+   *
+   * Intended to facilitate users the access to methods in the exporter.
+   */
   ExporterFilterType *
   GetExporter() const;
 
-  /** This call delegates the update to the importer */
+  /** This call delegates the update to the importer. */
   void
   Update() override;
 
-  /** This call delegates the update to the importer */
+  /** This call delegates the update to the importer. */
   void
   UpdateLargestPossibleRegion() override;
 

Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.hxx

@@ -22,9 +22,6 @@
 namespace itk
 {
 
-/**
- * Constructor
- */
 template <typename TInputImage>
 ImageToVTKImageFilter<TInputImage>::ImageToVTKImageFilter()
 {
@@ -48,9 +45,6 @@ ImageToVTKImageFilter<TInputImage>::ImageToVTKImageFilter()
   m_Importer->SetCallbackUserData(m_Exporter->GetCallbackUserData());
 }
 
-/**
- * Destructor
- */
 template <typename TInputImage>
 ImageToVTKImageFilter<TInputImage>::~ImageToVTKImageFilter()
 {
@@ -61,9 +55,6 @@ ImageToVTKImageFilter<TInputImage>::~ImageToVTKImageFilter()
   }
 }
 
-/**
- * Set an itk::Image as input
- */
 template <typename TInputImage>
 void
 ImageToVTKImageFilter<TInputImage>::SetInput(const InputImageType * inputImage)
@@ -78,49 +69,34 @@ ImageToVTKImageFilter<TInputImage>::GetInput() -> InputImageType *
   return m_Exporter->GetInput();
 }
 
-/**
- * Get a vtkImage as output
- */
 template <typename TInputImage>
 vtkImageData *
 ImageToVTKImageFilter<TInputImage>::GetOutput() const
 {
   return m_Importer->GetOutput();
 }
 
-/**
- * Get the importer filter
- */
 template <typename TInputImage>
 vtkImageImport *
 ImageToVTKImageFilter<TInputImage>::GetImporter() const
 {
   return m_Importer;
 }
 
-/**
- * Get the exporter filter
- */
 template <typename TInputImage>
 auto
 ImageToVTKImageFilter<TInputImage>::GetExporter() const -> ExporterFilterType *
 {
   return m_Exporter.GetPointer();
 }
 
-/**
- * Delegate the Update to the importer
- */
 template <typename TInputImage>
 void
 ImageToVTKImageFilter<TInputImage>::Update()
 {
   m_Importer->Update();
 }
 
-/**
- * Delegate the UpdateLargestPossibleRegion to the importer
- */
 template <typename TInputImage>
 void
 ImageToVTKImageFilter<TInputImage>::UpdateLargestPossibleRegion()

Modules/Bridge/VtkGlue/include/itkVTKImageToImageFilter.h

@@ -69,21 +69,22 @@ class ITK_TEMPLATE_EXPORT VTKImageToImageFilter : public VTKImageImport<TOutputI
   using OutputImageType = TOutputImage;
   using OutputImagePointer = typename OutputImageType::ConstPointer;
 
-  /** Set the input in the form of a vtkImageData */
+  /** Set the input in the form of a vtkImageData. */
   void
   SetInput(vtkImageData *);
   using Superclass::SetInput;
 
-  /** Return the internal VTK image exporter filter.
-      This is intended to facilitate users the access
-      to methods in the exporter */
+  /** Get the internal VTK image exporter filter.
+   *
+   * Intended to facilitate users the access to methods in the exporter.
+   */
   vtkImageExport *
   GetExporter() const;
 
-  /** Return the internal ITK image importer filter.
-      This is intended to facilitate users the access
-      to methods in the importer.
-      */
+  /** Get the internal ITK image importer filter.
+   *
+   * Intended to facilitate users the access to methods in the importer.
+   */
   const Superclass *
   GetImporter() const;
 

Modules/Bridge/VtkGlue/include/itkVTKImageToImageFilter.hxx

@@ -25,9 +25,6 @@
 namespace itk
 {
 
-/**
- * Constructor
- */
 template <typename TOutputImage>
 VTKImageToImageFilter<TOutputImage>::VTKImageToImageFilter()
 {
@@ -51,9 +48,6 @@ VTKImageToImageFilter<TOutputImage>::VTKImageToImageFilter()
   this->SetCallbackUserData(m_Exporter->GetCallbackUserData());
 }
 
-/**
- * Destructor
- */
 template <typename TOutputImage>
 VTKImageToImageFilter<TOutputImage>::~VTKImageToImageFilter()
 {
@@ -64,9 +58,6 @@ VTKImageToImageFilter<TOutputImage>::~VTKImageToImageFilter()
   }
 }
 
-/**
- * Set a vtkImageData as input
- */
 template <typename TOutputImage>
 void
 VTKImageToImageFilter<TOutputImage>::SetInput(vtkImageData * inputImage)
@@ -78,19 +69,13 @@ VTKImageToImageFilter<TOutputImage>::SetInput(vtkImageData * inputImage)
 #endif
 }
 
-/**
- * Get the exporter filter
- */
 template <typename TOutputImage>
 vtkImageExport *
 VTKImageToImageFilter<TOutputImage>::GetExporter() const
 {
   return m_Exporter;
 }
 
-/**
- * Get the importer filter
- */
 template <typename TOutputImage>
 auto
 VTKImageToImageFilter<TOutputImage>::GetImporter() const -> const Superclass *

Modules/Compatibility/Deprecated/include/itkChildTreeIterator.h

@@ -41,15 +41,15 @@ class ITK_TEMPLATE_EXPORT ChildTreeIterator : public TreeIteratorBase<TTreeType>
   /** Constructor */
   ChildTreeIterator(const TreeIteratorBase<TTreeType> & iterator);
 
-  /** Get the type of the iterator */
+  /** Get the type of the iterator. */
   NodeType
   GetType() const override;
 
-  /** Go to a specific child node */
+  /** Go to a specific child node. */
   bool
   GoToChild(ChildIdentifier number = 0) override;
 
-  /** Go to a parent node */
+  /** Go to the parent node. */
   bool
   GoToParent() override;
 
@@ -72,11 +72,11 @@ class ITK_TEMPLATE_EXPORT ChildTreeIterator : public TreeIteratorBase<TTreeType>
   }
 
 protected:
-  /** Get the next value */
+  /** Get the next node. */
   const ValueType &
   Next() override;
 
-  /** Return true if the next value exists */
+  /** Return true if the next node exists. */
   bool
   HasNext() const override;
 

Modules/Compatibility/Deprecated/include/itkChildTreeIterator.hxx

@@ -22,7 +22,6 @@
 namespace itk
 {
 
-/** Constructor */
 template <typename TTreeType>
 ChildTreeIterator<TTreeType>::ChildTreeIterator(TTreeType * tree, const TreeNodeType * start)
   : TreeIteratorBase<TTreeType>(tree, start)
@@ -42,7 +41,6 @@ ChildTreeIterator<TTreeType>::ChildTreeIterator(const TreeIteratorBase<TTreeType
   this->m_Position = m_ParentNode->GetChild(m_ListPosition);
 }
 
-/** Go to a specific child */
 template <typename TTreeType>
 bool
 ChildTreeIterator<TTreeType>::GoToChild(ChildIdentifier number)
@@ -59,7 +57,6 @@ ChildTreeIterator<TTreeType>::GoToChild(ChildIdentifier number)
   return true;
 }
 
-/** Go to the parent node */
 template <typename TTreeType>
 bool
 ChildTreeIterator<TTreeType>::GoToParent()
@@ -78,15 +75,13 @@ ChildTreeIterator<TTreeType>::GoToParent()
   return true;
 }
 
-/** Return the type of the iterator */
 template <typename TTreeType>
 auto
 ChildTreeIterator<TTreeType>::GetType() const -> NodeType
 {
   return TreeIteratorBaseEnums::TreeIteratorBaseNode::CHILD;
 }
 
-/** Return true if the next node exists */
 template <typename TTreeType>
 bool
 ChildTreeIterator<TTreeType>::HasNext() const
@@ -101,7 +96,6 @@ ChildTreeIterator<TTreeType>::HasNext() const
   }
 }
 
-/** Return the next node */
 template <typename TTreeType>
 auto
 ChildTreeIterator<TTreeType>::Next() -> const ValueType &
@@ -115,7 +109,6 @@ ChildTreeIterator<TTreeType>::Next() -> const ValueType &
   return this->m_Position->Get();
 }
 
-/** Clone function */
 template <typename TTreeType>
 TreeIteratorBase<TTreeType> *
 ChildTreeIterator<TTreeType>::Clone()

Modules/Compatibility/Deprecated/include/itkLevelOrderTreeIterator.h

@@ -45,28 +45,28 @@ class ITK_TEMPLATE_EXPORT LevelOrderTreeIterator : public TreeIteratorBase<TTree
   /** Constructor with end level specification */
   LevelOrderTreeIterator(TreeType * tree, int endLevel = INT_MAX, const TreeNodeType * start = nullptr);
 
-  /** Constructor with end level specification */
+  /** Constructor with end level specification. */
   LevelOrderTreeIterator(TreeType * tree, int startLevel, int endLevel, const TreeNodeType * start = nullptr);
 
   ~LevelOrderTreeIterator() override = default;
 
-  /** Get the type of the iterator */
+  /** Get the type of the iterator. */
   NodeType
   GetType() const override;
 
-  /** Get the start level */
+  /** Get the start level. */
   int
   GetStartLevel() const;
 
-  /** Get the end level */
+  /** Get the end level. */
   int
   GetEndLevel() const;
 
-  /** Get the current level */
+  /** Get the current level. */
   int
   GetLevel() const;
 
-  /** Clone function */
+  /** Clone function. */
   TreeIteratorBase<TTreeType> *
   Clone() override;
 
@@ -85,21 +85,24 @@ class ITK_TEMPLATE_EXPORT LevelOrderTreeIterator : public TreeIteratorBase<TTree
   }
 
 protected:
-  /** Return the next node */
+  /** Get the next node. */
   const ValueType &
   Next() override;
 
-  /** Return true if the next node exists */
+  /** Return true if the next node exists. */
   bool
   HasNext() const override;
 
 private:
+  /** Find the next available node. */
   const TreeNodeType *
   FindNextNode() const;
 
+  /** Helper function to find the next node. */
   const TreeNodeType *
   FindNextNodeHelp() const;
 
+  /** Get the level given a node. */
   int
   GetLevel(const TreeNodeType * node) const;