Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unknown parameter name for documentation #5179

Closed
albert-github opened this issue Jan 25, 2025 · 2 comments · Fixed by #5192
Closed

Unknown parameter name for documentation #5179

albert-github opened this issue Jan 25, 2025 · 2 comments · Fixed by #5192
Assignees
Labels
type:Documentation Documentation improvement or change

Comments

@albert-github
Copy link
Contributor

...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.

@albert-github albert-github added the type:Documentation Documentation improvement or change label Jan 25, 2025
@hjmjohnson hjmjohnson added this to the ITK 6.0 Beta 1 milestone Jan 25, 2025
@hjmjohnson hjmjohnson self-assigned this Jan 25, 2025
@dzenanz
Copy link
Member

dzenanz commented Jan 27, 2025

We should maybe change

"itkNotUsed(x)="

to itkNotUsed(x)=x.

@albert-github
Copy link
Contributor Author

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

Probably even better:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Documentation Documentation improvement or change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants