Skip to content

Commit 92ae16f

Browse files
jhlegarretadzenanz
authored andcommitted
DOC: Fix miscellaneous Doxygen warnings
Fix miscellaneous Doxygen warnings. Fixes: ``` Modules/Filtering/BiasCorrection/include/itkMRASlabIdentifier.h:161: warning: Reached end of file while still inside a (nested) comment. Nesting level 1 (probable line reference: 27) Modules/Filtering/BiasCorrection/include/itkMRASlabIdentifier.h:64: warning: End of comment block while inside formula. ``` and ``` Modules/IO/NIFTI/include/itkNiftiImageIO.h:162: warning: argument 'fileName' of command @PARAM is not found in the argument list of itk::NiftiImageIO::CanWriteFile(const char *FileNameToWrite) Modules/IO/NIFTI/include/itkNiftiImageIO.h:168: warning: The following parameters of itk::NiftiImageIO::CanWriteFile(const char *FileNameToWrite) are not documented: parameter 'FileNameToWrite' Modules/IO/NIFTI/include/itkNiftiImageIO.h:162: warning: argument 'fileName' of command @PARAM is not found in the argument list of itk::NiftiImageIO::CanWriteFile(const char *FileNameToWrite) ``` and ``` Modules/IO/MeshOBJ/include/itkOBJMeshIO.h:57: warning: argument 'FileNameToRead' of command @PARAM is not found in the argument list of itk::OBJMeshIO::CanReadFile(const char *fileName) ``` Reported in: https://open.cdash.org/viewBuildError.php?type=1&onlydeltap&buildid=8175572
1 parent a0ba000 commit 92ae16f

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

Modules/Filtering/BiasCorrection/include/itkMRASlabIdentifier.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ namespace itk
4747
* For this identifier, a slice means 2D image data which is extracted from
4848
* the input image along one of three axes \f$(x, y, z)\f$. Users can specify
4949
* the slicing axis using the SetSlicingDirection(int dimension) member, where
50-
* the \p dimension variable follows the convention \f{X, Y, Z} : {0, 1, 2}\f$.
50+
* the \p dimension variable follows the convention \f${X, Y, Z} : {0, 1, 2}\f$.
5151
*
5252
* The identification scheme used works according to the following steps:
5353
* -# Users should specify how many pixels per slice the identifier

Modules/IO/MeshOBJ/include/itkOBJMeshIO.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class ITKIOMeshOBJ_EXPORT OBJMeshIO : public MeshIOBase
5555
/*-------- This part of the interfaces deals with reading data. ----- */
5656

5757
/** Determine if the file can be read with this MeshIO implementation.
58-
* \param FileNameToRead The name of the file to test for reading.
58+
* \param fileName The name of the file to test for reading.
5959
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
6060
* \return Returns true if this MeshIO can read the file specified.
6161
*/

Modules/IO/NIFTI/include/itkNiftiImageIO.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ class ITKIONIFTI_EXPORT NiftiImageIO : public ImageIOBase
152152
//-------- This part of the interfaces deals with writing data. -----
153153

154154
/** Determine if the file can be written with this ImageIO implementation.
155-
* \param fileName The name of the file to test for writing.
155+
* \param FileNameToWrite The name of the file to test for writing.
156156
* \post Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite
157157
* \return Returns true if this ImageIO can write the file specified.
158158
*/

0 commit comments

Comments
 (0)