Skip to content

DOC: Clean up method Doxygen documentation#3866

Merged
dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom
jhlegarreta:CleanupMethodDoxygenDocs
Jan 23, 2023
Merged

DOC: Clean up method Doxygen documentation#3866
dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom
jhlegarreta:CleanupMethodDoxygenDocs

Conversation

@jhlegarreta
Copy link
Copy Markdown
Member

@jhlegarreta jhlegarreta commented Jan 13, 2023

Clean up method Doxygen documentation:

  • Consolidate documentation so that methods are documented in the header
    files. By doing this fix the documentation of methods which had the
    wrong documentation (e.g. copied from another existing, unrelated
    method).
  • Remove the documentation of trivial methods: constructors,
    destructors, PrintSelf methods, etc.
  • Remove non-descriptive documentation of instance variables whose
    documentation should dwell in their public Get/Set macros according to
    the ITK SWG coding style guideline.
  • Remove documentation blocks consisting solely of the method name from
    the implementation files.
  • Remove unnecessary method ending brace comment blocks.
  • Remove empty method documentation blocks from implementation file.
  • Fix typos and method names cross-referenced in the documentation.
  • Take advantage of the commit to improve the documentation style
    (capitalize first letter in sentence, finish sentences with a period,
    split brief and detailed documentation sentences, etc.)

Note that many of the implementation file method documentation blocks were not in a Doxygen-recognizable format either:
https://doxygen.nl/manual/docblocks.html

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 area:Core Issues affecting the Core module 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 area:Video Issues affecting the Video module type:Documentation Documentation improvement or change labels Jan 13, 2023
@jhlegarreta
Copy link
Copy Markdown
Member Author

This is by no means intended to be exhaustive. I was having a look at some other things across these files, and thought that I would take the time to the consolidate documentation in these files, clean up unnecessary blocks, etc.

OutputTypeSpecializationStructType<Type>) const;

/** Specialized versions of Evaluate() method to handle scalar or vector pixel types.*/
/** Specialized version of Evaluate() method to handle scalar pixel types.*/
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is the removal of or vector intended?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes Matt. It looks like there are two versions for each of these methods, one for scalar types and the other one for vector types; at least that was what was being said in the implementation file. Please check.

@jhlegarreta jhlegarreta force-pushed the CleanupMethodDoxygenDocs branch 13 times, most recently from cde0136 to bb19a40 Compare January 15, 2023 20:03
@github-actions github-actions bot added the area:Bridge Issues affecting the Bridge module label Jan 15, 2023
@jhlegarreta
Copy link
Copy Markdown
Member Author

There are surely a few hundreds of other files where this should be done, but they can be addressed in separate PRs as time permits. To me, this is a step forward.

@jhlegarreta jhlegarreta force-pushed the CleanupMethodDoxygenDocs branch 2 times, most recently from 0d15f20 to 08e5e3a Compare January 15, 2023 22:46
@dzenanz
Copy link
Copy Markdown
Member

dzenanz commented Jan 16, 2023

This has merge conflicts now. Please rebase.

@jhlegarreta jhlegarreta force-pushed the CleanupMethodDoxygenDocs branch from 08e5e3a to b835723 Compare January 16, 2023 16:37
@jhlegarreta jhlegarreta force-pushed the CleanupMethodDoxygenDocs branch 2 times, most recently from 8b41cdd to 007df74 Compare January 19, 2023 21:23
@jhlegarreta jhlegarreta force-pushed the CleanupMethodDoxygenDocs branch from 007df74 to e232c0d Compare January 19, 2023 23:56
Clean up method Doxygen documentation:
- Consolidate documentation so that methods are documented in the header
  files. By doing this fix the documentation of methods which had the
  wrong documentation (e.g. copied from another existing, unrelated
  method).
- Remove the documentation of trivial methods: constructors,
  destructors, `PrintSelf` methods, etc.
- Remove non-descriptive documentation of instance variables whose
  documentation should dwell in their public Get/Set macros according to
  the ITK SWG coding style guideline.
- Remove documentation blocks consisting solely of the method name from
  the implementation files.
- Remove unnecessary method ending brace comment blocks.
- Remove empty method documentation blocks from implementation file.
- Fix typos and method names cross-referenced in the documentation.
- Take advantage of the commit to improve the documentation style
  (capitalize first letter in sentence, finish sentences with a period,
  split brief and detailed documentation sentences, etc.)

Note that many of the implementation file method documentation blocks
were not in a Doxygen-recognizable format either:
https://doxygen.nl/manual/docblocks.html
@jhlegarreta jhlegarreta force-pushed the CleanupMethodDoxygenDocs branch from e232c0d to bcf15f0 Compare January 21, 2023 19:24
@dzenanz dzenanz merged commit d58bf56 into InsightSoftwareConsortium:master Jan 23, 2023
@jhlegarreta jhlegarreta deleted the CleanupMethodDoxygenDocs branch January 23, 2023 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Bridge Issues affecting the Bridge module area:Core Issues affecting the Core module 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 area:Video Issues affecting the Video module type:Documentation Documentation improvement or change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants