Skip to content

Unknown parameter name for documentation #5179

@albert-github

Description

@albert-github
...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.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions