DOC: Improve itk::RGBGibbsPriorFilter documentation
#4200
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
type:Documentation
jhlegarreta
force-pushed
the
ImproveRGBGibbsPriorFilterDocumentation
branch
2 times, most recently
from
f3a965d
to
32cf87c
Compare
dzenanz
approved these changes
Sep 4, 2023
Use Doxygen math syntax for math notation in `itk::RGBGibbsPriorFilter`.
Document `itk::RGBGibbsPriorFilter` class methods in header file only: Doxygen picks the method documentation from the header files, and leaves the method documentation empty if it does not find it there. So remove the method documentation from the implementation file. Take advantage of the commit to use the Doxygen math syntax where math symbols are used in the doumented methods.
Use proper Doxygen documentation style in `itk::RGBGibbsPriorFilter`: place the variables and type alias documentation blocks on the immediate preceding line. Take advantage of the commit to: - Reword the documentation where appropriate: especially, remove unnecessary articles that refer to the ivar being documented. - Use the Doxygen math syntax to highlight math symbols.
Prefer double forward slashes for within-method body comment blocks following the ITK SWG coding style guidelines. Reword the comments as appropriate to improve grammar. Follow-up to commit be6b447.
jhlegarreta
force-pushed
the
ImproveRGBGibbsPriorFilterDocumentation
branch
from
32cf87c
to
8d3df52
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RGBGibbsPriorFilterclass methods in header file onlyRGBGibbsPriorFilterPR Checklist