Skip to content

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 28, 2025
Merged

DOC: Grouping shared documentation #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 */}
Copy link
Member

Choose a reason for hiding this comment

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

by means of : using ?

Copy link
Contributor Author

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?

Copy link
Member

Choose a reason for hiding this comment

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

Sounds more straightforward.

and \code{/** @ITKEndGrouping */}:

\small
\begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{cpp}
public:
/** Set/Get the standard deviation of the Gaussian used for smoothing. */
/** @ITKStartGrouping */
itkSetMacro(Sigma, SigmaArrayType);
itkGetConstMacro(Sigma, SigmaArrayType);
/** @ITKEndGrouping */

\end{minted}
\normalsize


\subsection{Documenting Macros}
\label{subsec:DocumentingMacros}
Expand Down