Skip to content

Commit

Permalink
DOC: Use Doxygen syntax to create automatic links to members
Browse files Browse the repository at this point in the history
Use Doxygen syntax to create automatic links to members.

According to the relevant Doxygen documentation:
https://doxygen.nl/manual/autolink.html
  • Loading branch information
jhlegarreta committed Sep 27, 2022
1 parent 4b5842f commit 3025d83
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions Modules/Core/Common/include/itkImageToImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ namespace itk
* first.
*
* All inputs to ImageToImageFilter (if there is more than one) are
* checked in the VerifyInputInformation method to verify that they
* checked in the VerifyInputInformation() method to verify that they
* occupy the same physical space. If the input images are in the
* same physical space, then the location of each voxel is identical,
* and the filter can operate voxel-by-voxel in index space. Some
* filters -- registration filters, for example -- will violate this
* precondition, in which case they should redefine
* VerifyInputInformation to relax or eliminate this requirement.
* VerifyInputInformation() to relax or eliminate this requirement.
*
* Access methods -- Set/GetCoordinateTolerance and
* Set/GetDirectionTolerance -- are provided for cases where the
Expand Down Expand Up @@ -227,7 +227,7 @@ class ITK_TEMPLATE_EXPORT ImageToImageFilter
/** \brief Verifies that the input images occupy the same physical
* space and the each index is at the same physical location.
*
* The default implementation of the PropagateRequestedRegion
* The default implementation of the PropagateRequestedRegion()
* methods copies the index and size from the output to the
* input. This makes an implicit assumption that the images occupy
* the same physical location at each voxel. This method enforces
Expand Down
4 changes: 2 additions & 2 deletions Modules/Core/Common/include/itkProcessObject.h
Original file line number Diff line number Diff line change
Expand Up @@ -779,11 +779,11 @@ class ITKCommon_EXPORT ProcessObject : public Object
* correctly, that all required inputs are set, and needed parameters
* are set appropriately. If not valid an exceptions will be thrown.
*
* This method is called before UpdateOutputInformation is
* This method is called before UpdateOutputInformation() is
* propagated to the inputs.
*
* The ProcessObject's implementation verifies that the
* NumberOfRequiredInputs are set and not null.
* #m_NumberOfRequiredInputs are set and not null.
*
*/
virtual void
Expand Down
14 changes: 7 additions & 7 deletions Modules/IO/ImageBase/include/itkStreamingImageIOBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ class ITKIOImageBase_EXPORT StreamingImageIOBase : public ImageIOBase
void
PrintSelf(std::ostream & os, Indent indent) const override;

/** \brief Returns true if GetIORegion is not the same size as the
* largest region give by GetNumberOfDimensions.
/** \brief Returns true if GetIORegion() is not the same size as the
* largest region give by GetNumberOfDimensions().
*
* This compares the IORegion to the size of the image in the
* file. With out regaurd to the dimensions of either, if the
Expand Down Expand Up @@ -129,13 +129,13 @@ class ITKIOImageBase_EXPORT StreamingImageIOBase : public ImageIOBase
* \param _buffer is pointer to an allocated block of memory
* suitable to hold the IORegion of the pixel type
*
* This methods relies on GetDataPosition to determin where the
* data is located in the file. It uses m_IORegion to determin the
* This methods relies on GetDataPosition() to determin where the
* data is located in the file. It uses ImageIOBase#m_IORegion to determin the
* requested region to read.
*
* The files data is assumed to be unpadded and continuous in the
* file for the size of the image in the dimensions of the
* m_IORegion. This means that the image file could be broken into
* ImageIOBase#m_IORegion. This means that the image file could be broken into
* slices, but not blocks for this methods to be used.
*/
virtual bool
Expand All @@ -148,8 +148,8 @@ class ITKIOImageBase_EXPORT StreamingImageIOBase : public ImageIOBase
* \param _buffer is a pointer to the data in a continuous block
* for the region
*
* This methods relies on GetDataPosition to determin where the data
* is located in the file. It usesy m_IORegion determin the requested
* This methods relies on GetDataPosition() to determin where the data
* is located in the file. It usesy ImageIOBase#m_IORegion determin the requested
* region to written.
*/
virtual bool
Expand Down

0 comments on commit 3025d83

Please sign in to comment.