Skip to content

Commit

Permalink
DOC: Fix argument names in method Doxygen documentation
Browse files Browse the repository at this point in the history
Fix argument names in method Doxygen documentation.

Fixes:
```
Modules/IO/MeshBYU/include/itkBYUMeshIO.h:60:
warning: argument 'FileNameToRead' of command @param is not found in the argument list of itk::BYUMeshIO::CanReadFile(const char *fileName)
Modules/IO/MeshBYU/include/itkBYUMeshIO.h:66: warning:
The following parameters of itk::BYUMeshIO::CanReadFile(const char *fileName) are not documented
```

and similar warnings.

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 d7c0128 commit 56de405
Show file tree
Hide file tree
Showing 13 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkOctreeNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ class ITKCommon_EXPORT OctreeNode

/**
* Sets the color value of the specified Child for this OctreeNode
* \param NodeColor The desired color of this node.
* \param color The desired color of this node.
* \post All children of the specified child are removed, and the child is set to
* the desired value.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,23 +141,23 @@ class ITK_TEMPLATE_EXPORT FrequencyBandImageFilter : public UnaryFrequencyDomain
/**
* Utility method equivalent to:
* SetPassBand(true)
* SetPassLowFrequencyThreshold(pass_low_threshold)
* SetPassHighFrequencyThreshold(pass_high_threshold)
* SetPassLowFrequencyThreshold(passLowThreshold)
* SetPassHighFrequencyThreshold(passHighThreshold)
*
* @param pass_low_threshold flag to let pass or not low boundary
* @param pass_high_threshold flag to let pass or not high boundary
* @param passLowThreshold flag to let pass or not low boundary
* @param passHighThreshold flag to let pass or not high boundary
*/
void
SetPassBand(const bool passLowThreshold, const bool passHighThreshold);

/**
* Utility method equivalent to:
* SetPassBand(false)
* SetPassLowFrequencyThreshold(pass_low_threshold)
* SetPassHighFrequencyThreshold(pass_high_threshold)
* SetPassLowFrequencyThreshold(passLowThreshold)
* SetPassHighFrequencyThreshold(passHighThreshold)
*
* @param pass_low_threshold flag to let pass or not low boundary
* @param pass_high_threshold flag to let pass or not high boundary
* @param passLowThreshold flag to let pass or not low boundary
* @param passHighThreshold flag to let pass or not high boundary
*/
void
SetStopBand(const bool passLowThreshold, const bool passHighThreshold);
Expand Down
2 changes: 1 addition & 1 deletion Modules/IO/HDF5/include/itkHDF5ImageIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ class ITKIOHDF5_EXPORT HDF5ImageIO : public StreamingImageIOBase
/*-------- This part of the interfaces deals with writing data. ----- */

/** Determine if the file can be written with this ImageIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param name The name of the file to test for writing.
* \author Hans J. Johnson
* \post Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this ImageIO can write the file specified.
Expand Down
8 changes: 4 additions & 4 deletions Modules/IO/ImageBase/include/itkStreamingImageIOBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,9 @@ class ITKIOImageBase_EXPORT StreamingImageIOBase : public ImageIOBase

/** \brief Reads the set IORegion from os into buffer
*
* \param os is an istream presumed to be opened for reading in binary
* \param file is an istream presumed to be opened for reading in binary
* mode
* \param buffer is pointer to an allocated block of memory
* \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
Expand All @@ -143,9 +143,9 @@ class ITKIOImageBase_EXPORT StreamingImageIOBase : public ImageIOBase

/** \brief Writes the set IORegion from buffer into os
*
* \param os is an ostream presumed to be opened for writing and
* \param file is an ostream presumed to be opened for writing and
* reading
* \param buffer is a pointer to the data in a continuous block
* \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
Expand Down
4 changes: 2 additions & 2 deletions Modules/IO/MeshBYU/include/itkBYUMeshIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class ITKIOMeshBYU_EXPORT BYUMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with reading data. ----- */

/** Determine if the file can be read with this MeshIO implementation.
* \param FileNameToRead The name of the file to test for reading.
* \param fileName The name of the file to test for reading.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can read the file specified.
*/
Expand All @@ -85,7 +85,7 @@ class ITKIOMeshBYU_EXPORT BYUMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with writing data. ----- */

/** Determine if the file can be written with this MeshIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can write the file specified.
*/
Expand Down
4 changes: 2 additions & 2 deletions Modules/IO/MeshFreeSurfer/include/itkFreeSurferAsciiMeshIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class ITKIOMeshFreeSurfer_EXPORT FreeSurferAsciiMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with reading data. ----- */

/** Determine if the file can be read with this MeshIO implementation.
* \param FileNameToRead The name of the file to test for reading.
* \param fileName The name of the file to test for reading.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can read the file specified.
*/
Expand All @@ -83,7 +83,7 @@ class ITKIOMeshFreeSurfer_EXPORT FreeSurferAsciiMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with writing data. ----- */

/** Determine if the file can be written with this MeshIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can write the file specified.
*/
Expand Down
4 changes: 2 additions & 2 deletions Modules/IO/MeshFreeSurfer/include/itkFreeSurferBinaryMeshIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class ITKIOMeshFreeSurfer_EXPORT FreeSurferBinaryMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with reading data. ----- */

/** Determine if the file can be read with this MeshIO implementation.
* \param FileNameToRead The name of the file to test for reading.
* \param fileName The name of the file to test for reading.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can read the file specified.
*/
Expand All @@ -86,7 +86,7 @@ class ITKIOMeshFreeSurfer_EXPORT FreeSurferBinaryMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with writing data. ----- */

/** Determine if the file can be written with this MeshIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can write the file specified.
*/
Expand Down
4 changes: 2 additions & 2 deletions Modules/IO/MeshGifti/include/itkGiftiMeshIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class ITKIOMeshGifti_EXPORT GiftiMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with reading data. ----- */

/** Determine if the file can be read with this MeshIO implementation.
* \param FileNameToRead The name of the file to test for reading.
* \param fileName The name of the file to test for reading.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can read the file specified.
*/
Expand All @@ -109,7 +109,7 @@ class ITKIOMeshGifti_EXPORT GiftiMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with writing data. ----- */

/** Determine if the file can be written with this MeshIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can write the file specified.
*/
Expand Down
2 changes: 1 addition & 1 deletion Modules/IO/MeshOBJ/include/itkOBJMeshIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class ITKIOMeshOBJ_EXPORT OBJMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with writing data. ----- */

/** Determine if the file can be written with this MeshIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can write the file specified.
*/
Expand Down
4 changes: 2 additions & 2 deletions Modules/IO/MeshOFF/include/itkOFFMeshIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ class ITKIOMeshOFF_EXPORT OFFMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with reading data. ----- */

/** Determine if the file can be read with this MeshIO implementation.
* \param FileNameToRead The name of the file to test for reading.
* \param fileName The name of the file to test for reading.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can read the file specified.
*/
Expand All @@ -84,7 +84,7 @@ class ITKIOMeshOFF_EXPORT OFFMeshIO : public MeshIOBase
/*-------- This part of the interfaces deals with writing data. ----- */

/** Determine if the file can be written with this MeshIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can write the file specified.
*/
Expand Down
4 changes: 2 additions & 2 deletions Modules/IO/MeshVTK/include/itkVTKPolyDataMeshIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class ITKIOMeshVTK_EXPORT VTKPolyDataMeshIO : public MeshIOBase
/**-------- This part of the interfaces deals with reading data. ----- */

/** Determine if the file can be read with this MeshIO implementation.
* \param FileNameToRead The name of the file to test for reading.
* \param fileName The name of the file to test for reading.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can read the file specified.
*/
Expand All @@ -94,7 +94,7 @@ class ITKIOMeshVTK_EXPORT VTKPolyDataMeshIO : public MeshIOBase

/*-------- This part of the interfaces deals with writing data. ----- */
/** Determine if the file can be written with this MeshIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this MeshIO can write the file specified.
*/
Expand Down
2 changes: 1 addition & 1 deletion Modules/IO/NIFTI/include/itkNiftiImageIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ class ITKIONIFTI_EXPORT NiftiImageIO : public ImageIOBase
//-------- This part of the interfaces deals with writing data. -----

/** Determine if the file can be written with this ImageIO implementation.
* \param FileNameToWrite The name of the file to test for writing.
* \param fileName The name of the file to test for writing.
* \post Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite
* \return Returns true if this ImageIO can write the file specified.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,8 @@ class ITK_TEMPLATE_EXPORT ObjectToObjectMultiMetricv4
GetDerivative(DerivativeType &) const override;

/** Evaluate the metric value and derivative.
* \note \param value will contain the value of only the *first* metric on return.
* \param derivative holds the combined derivative on return.
* \param firstValue will contain the value of only the *first* metric on return.
* \param derivativeResult holds the combined derivative on return.
*
* \sa GetValueArray
* \sa GetWeightedValue */
Expand Down

0 comments on commit 56de405

Please sign in to comment.