InsightSoftwareConsortium / ITK

Insight Toolkit (ITK) -- Official Repository. ITK builds on a proven, spatially-oriented architecture for processing, segmentation, and registration of scientific images in two, three, or more dimensions.
https://itk.org
Apache License 2.0
1.47k stars 686 forks source link

Unknown parameter name for documentation #5179

Closed albert-github closed 5 days ago

albert-github commented 2 weeks ago
...ITK/Modules/Core/Common/include/itkImageBoundaryCondition.h:123: warning: argument 'outputRequestedRegion' of command @param is not found in the argument list of itk::ImageBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion(const RegionType &inputLargestPossibleRegion, const RegionType &) const

In the function we see:

  /** Determines the necessary input region for an output region given
   * the largest possible region of the input image. Subclasses should
   * override this method to efficiently support streaming.
   *
   * \param inputLargestPossibleRegion Largest possible region of the input image.
   * \param outputRequestedRegion The output requested region.
   * \return The necessary input region required to determine the
   * pixel values in the outputRequestedRegion.
   */
  virtual RegionType
  GetInputRequestedRegion(const RegionType &                  inputLargestPossibleRegion,
                          [[maybe_unused]] const RegionType & itkNotUsed(outputRequestedRegion)) const
  {
    return inputLargestPossibleRegion;
  }

and in the doxygen settings the PREDEFINED:

"itkNotUsed(x)="

In other words no variable present and hence the message.

dzenanz commented 1 week ago

We should maybe change https://github.com/InsightSoftwareConsortium/ITK/blob/fde014ae98d80e0c21d0a93340185eabd7c14b71/Wrapping/DoxygenConfig.cmake#L83 to itkNotUsed(x)=x.

albert-github commented 1 week ago

@dzenanz Indeed I apparently something went wrong during cut / paste.

Probably even better:

itkLegacyMacro(x)="[[deprecated]] x"