Skip to content

DOC: Document members in header methods#2533

Merged
dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom
jhlegarreta:DocumentMembersInHeaderFileMethods
May 19, 2021
Merged

DOC: Document members in header methods#2533
dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom
jhlegarreta:DocumentMembersInHeaderFileMethods

Conversation

@jhlegarreta
Copy link
Copy Markdown
Member

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.

PR Checklist

@github-actions github-actions Bot added area:Filtering Issues affecting the Filtering module area:IO Issues affecting the IO module area:Numerics Issues affecting the Numerics module area:Registration Issues affecting the Registration module area:Segmentation Issues affecting the Segmentation module labels May 15, 2021
@jhlegarreta
Copy link
Copy Markdown
Member Author

jhlegarreta commented May 15, 2021

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.

@jhlegarreta jhlegarreta added the type:Documentation Documentation improvement or change label May 15, 2021
@jhlegarreta jhlegarreta force-pushed the DocumentMembersInHeaderFileMethods branch from a2b27b6 to 01b8acd Compare May 15, 2021 19:20
@github-actions github-actions Bot removed the type:Documentation Documentation improvement or change label May 15, 2021
@jhlegarreta jhlegarreta force-pushed the DocumentMembersInHeaderFileMethods branch from 01b8acd to 51b8b5b Compare May 16, 2021 12:13
@dzenanz
Copy link
Copy Markdown
Member

dzenanz commented May 18, 2021

Please rebase to resolve conflicts.

@jhlegarreta jhlegarreta force-pushed the DocumentMembersInHeaderFileMethods branch 2 times, most recently from d6e20f6 to d99bb80 Compare May 19, 2021 00:24
@jhlegarreta
Copy link
Copy Markdown
Member Author

Please rebase to resolve conflicts.

Done.

@jhlegarreta jhlegarreta added the action:ApplyClangFormat Add this label to a pull request to apply `clang-format` to the branch label May 19, 2021
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.
@jhlegarreta jhlegarreta force-pushed the DocumentMembersInHeaderFileMethods branch from d99bb80 to fb4a5e7 Compare May 19, 2021 01:06
@dzenanz dzenanz merged commit 67632ac into InsightSoftwareConsortium:master May 19, 2021
@jhlegarreta jhlegarreta deleted the DocumentMembersInHeaderFileMethods branch May 19, 2021 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

action:ApplyClangFormat Add this label to a pull request to apply `clang-format` to the branch area:Filtering Issues affecting the Filtering module area:IO Issues affecting the IO module area:Numerics Issues affecting the Numerics module area:Registration Issues affecting the Registration module area:Segmentation Issues affecting the Segmentation module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants