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

Assorted doxygen-related fixes #5192

Merged
merged 4 commits into from
Feb 4, 2025

Conversation

dzenanz
Copy link
Member

@dzenanz dzenanz commented Jan 27, 2025

Closes #5179. Closes #2481. Closes #5184.

PR Checklist

  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Updated API documentation (or API not changed)

@github-actions github-actions bot added the type:Compiler Compiler support or related warnings label Jan 27, 2025
@dzenanz dzenanz requested a review from jhlegarreta January 28, 2025 15:50
@github-actions github-actions bot added type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots area:Documentation Issues affecting the Documentation module labels Jan 28, 2025
@dzenanz dzenanz changed the title COMP: Fix unknown parameter name coming from doxygen Assorted doxygen-related fixes Jan 28, 2025
Copy link
Member

@jhlegarreta jhlegarreta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing all this 💯 Dženan.

I'd like to see commit message bodies describing what the commit contains/does as a change and what issue the commit fixes.

@dzenanz
Copy link
Member Author

dzenanz commented Jan 28, 2025

The linked issues contain the details.

@jhlegarreta
Copy link
Member

The linked issues contain the details.

I know, but:

  • When inspecting the history in the command line that information is missing.
  • Having the necessary context information saves any maintainer that was not aware of the issues the task of going over all those issues and threads.

@dzenanz
Copy link
Member Author

dzenanz commented Jan 29, 2025

Feel free to amend this PR with the commit messages you would like to see. It is unlikely I will get around to it until next week.

@jhlegarreta
Copy link
Member

I can wait Dženan. I think the importance of this question has been stressed many times.

@hjmjohnson
Copy link
Member

I think these changes are so small that the subject line is the complete description.

Closes InsightSoftwareConsortium#5179. To address warnings of the style:

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

Closes InsightSoftwareConsortium#2481. Avoid itkLegacyMacro from appearing in the API docs.
Add to Wrapping/DoxygenConfig.cmake the two lines that were
recently added to Utilities/Doxygen/DoxygenConfig.cmake.
To prevent warnings about large graphs. Closes InsightSoftwareConsortium#5184.
@dzenanz dzenanz requested a review from jhlegarreta February 4, 2025 15:46
@github-actions github-actions bot removed the type:Compiler Compiler support or related warnings label Feb 4, 2025
@dzenanz dzenanz merged commit cc0de40 into InsightSoftwareConsortium:master Feb 4, 2025
19 of 20 checks passed
@dzenanz dzenanz deleted the docFixes branch February 4, 2025 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Documentation Issues affecting the Documentation module type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots
Projects
None yet
4 participants