DOC: Clean up method Doxygen documentation#3866
DOC: Clean up method Doxygen documentation#3866dzenanz merged 1 commit intoInsightSoftwareConsortium:masterfrom
Conversation
|
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.*/ |
There was a problem hiding this comment.
Is the removal of or vector intended?
There was a problem hiding this comment.
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.
cde0136 to
bb19a40
Compare
|
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. |
0d15f20 to
08e5e3a
Compare
|
This has merge conflicts now. Please rebase. |
08e5e3a to
b835723
Compare
8b41cdd to
007df74
Compare
007df74 to
e232c0d
Compare
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
e232c0d to
bcf15f0
Compare
Clean up method Doxygen documentation:
files. By doing this fix the documentation of methods which had the
wrong documentation (e.g. copied from another existing, unrelated
method).
destructors,
PrintSelfmethods, etc.documentation should dwell in their public Get/Set macros according to
the ITK SWG coding style guideline.
the implementation files.
(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