DOC: Document members in header methods#2533
Merged
dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom May 19, 2021
Merged
DOC: Document members in header methods#2533dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom
dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom
Conversation
Member
Author
|
Note that this change does not mean to be exhaustive at all. I just came across these cases while I was working on #2327. Thanks. |
a2b27b6 to
01b8acd
Compare
01b8acd to
51b8b5b
Compare
dzenanz
approved these changes
May 17, 2021
Member
|
Please rebase to resolve conflicts. |
d6e20f6 to
d99bb80
Compare
Member
Author
Done. |
Document members in header methods. Transfer the documentation from the ivar or the method definition to the header methods where the documentation was incomplete or missing. Take advantage of the commit to: - Improve the syntax of the existing documentation to stick to the recommendations of the ITK SW Guide to generate the Doxygen documentation (i.e. use the `/** <documentation.> */` convention). - Improve the style of the existing documentation (e.g. capitals, punctuation) to stick to the recommendations of the ITK SW Guide. - Improve the wording of some comments. - Remove the documentation of methods that are either not documented as per the ITK SW Guide (e.g. constructors) or which are inherited members whose purpose is not modified (e.g. `PrintSelf`). - Remove the comments used to mark the end of a method, which are not considered as necessary by the ITK SW Guide. - Remove empty documentation blocks. - Move the private member methods before the variables.
d99bb80 to
fb4a5e7
Compare
dzenanz
approved these changes
May 19, 2021
This file contains hidden or 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
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.
Document members in header methods.
Transfer the documentation from the ivar or the method definition to the
header methods where the documentation was incomplete or missing.
Take advantage of the commit to:
recommendations of the ITK SW Guide to generate the Doxygen
documentation (i.e. use the
/** <documentation.> */convention).punctuation) to stick to the recommendations of the ITK SW Guide.
per the ITK SW Guide (e.g. constructors) or which are inherited members
whose purpose is not modified (e.g.
PrintSelf).considered as necessary by the ITK SW Guide.
PR Checklist