-
Notifications
You must be signed in to change notification settings - Fork 17
DOC: Grouping shared documentation #225
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Grouping shared documentation #225
Conversation
Documentation for InsightSoftwareConsortium/ITK#5262 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/** @ITKStartGrouping */
vs. /**@ITKEndGrouping*/
: why does the former need whitespaces before/after the alias?
@@ -4273,6 +4273,22 @@ \subsection{Documenting Data Members} | |||
\code{Set\#\#name} method should also be documented following the above | |||
guidelines. | |||
|
|||
Data members that should share the same documentation description should be embedded in | |||
the Doxygen grouping commands by means of the comments \code{/** @ITKStartGrouping */} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
by means of : using ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jhlegarreta Not sure if this is meant as correction or as a style / discussion item from your side?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds more straightforward.
The whitespace is not relevant here, but I used the same comments as I used in the mentioned PR InsightSoftwareConsortium/ITK#5262 |
If they are arbitrary, then please remove them. |
I'd rather add them to the |
👍.
Yes, please. Thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! To be squashed upon merging.
Written a small item about grouping shared documentation.
787cb69
to
9d9f5c5
Compare
Written a small item about grouping shared documentation.