Skip to content

Commit

Permalink
DOC: Fix unexpected token in class documentation
Browse files Browse the repository at this point in the history
Fix unexpected token in the `itk::TransformGeometryImageFilter` class
documentation.

Remove the `\param` Doxygen commands from a non-function documentation
block, and reuse part of the documentation to describe what the filter
yields as its output.

Avoid duplicating the type of transformation the filter accepts in the
corresponding `Transform` macro (as it is already present in the class
documentation).

Take advantage of the commit to remove an unnecessary/uninformative part
from the `InputImage` macro.

Fixes:
```
Modules/Core/Transform/include/itkTransformGeometryImageFilter.h:45:
warning:
unexpected token in comment block while parsing the argument of command param
```

Reported for example in:
https://open.cdash.org/viewBuildError.php?type=1&buildid=8167118
  • Loading branch information
jhlegarreta authored and dzenanz committed Sep 23, 2022
1 parent 56de405 commit 14e53cb
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions Modules/Core/Transform/include/itkTransformGeometryImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ namespace itk
* \brief Modify an image's geometric meta-data, changing its "physical" extent.
*
* The TransformGeometryImageFilter "physically" changes the image in
* space using the given transformation. The
* specific transformation type can be any type derived from the
* space using the given transformation. The resulting image is an image with
* the same voxel values as the input, but with different physical space
* representation as affected by the transform.
*
* The specific transformation type can be any type derived from the
* MatrixOffsetTransformBase and the TranslationTransform.
* The modification of the geometric meta-data is an alternative to
* resampling the moving image onto the fixed image grid, after registration. The advantages of using
Expand All @@ -44,12 +47,6 @@ namespace itk
* should be saved in a format that supports a non ortho-normal
* direction cosine matrix (e.g. nrrd).
*
* \param \c Transform Any transform derived from MatrixOffsetTransformBase or TranslationTransform.
* \param \c InputImage The image to be duplicated and modified to incorporate the
* transform.
* \return An image with the same voxel values as the input, but with different
* physical space representation affected by the transform.
*
* Let us call the transform operation from the fixed image to moving image <tt>TfmF2M</tt>.
* Given a set of points from the fixed image in physical space (i.e. <tt>physicalFixedImagePoints</tt>),
* the aim is to convert those points into the moving image physical space as
Expand Down Expand Up @@ -146,7 +143,7 @@ class ITK_TEMPLATE_EXPORT TransformGeometryImageFilter : public InPlaceImageFilt
/** Set/Get required rigid transform. */
itkSetGetDecoratedObjectInputMacro(Transform, TransformType);

/** Set/Get required input image. (A wrapper to this->Set/GetInput()) */
/** Set/Get required input image. */
itkSetInputMacro(InputImage, InputImageType);
itkGetInputMacro(InputImage, InputImageType);

Expand Down

0 comments on commit 14e53cb

Please sign in to comment.