Skip to content

Commit 5ea45e3

Browse files
albert-githubdzenanz
authored andcommitted
DOC: Grouping shared documentation
Written a small item about grouping shared documentation.
1 parent ee9da15 commit 5ea45e3

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4273,6 +4273,22 @@ \subsection{Documenting Data Members}
42734273
\code{Set\#\#name} method should also be documented following the above
42744274
guidelines.
42754275
4276+
Data members that should share the same documentation description should be embedded in
4277+
the Doxygen grouping commands by means of the comments \code{/** @ITKStartGrouping */}
4278+
and \code{/** @ITKEndGrouping */}:
4279+
4280+
\small
4281+
\begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{cpp}
4282+
public:
4283+
/** Set/Get the standard deviation of the Gaussian used for smoothing. */
4284+
/** @ITKStartGrouping */
4285+
itkSetMacro(Sigma, SigmaArrayType);
4286+
itkGetConstMacro(Sigma, SigmaArrayType);
4287+
/** @ITKEndGrouping */
4288+
4289+
\end{minted}
4290+
\normalsize
4291+
42764292
42774293
\subsection{Documenting Macros}
42784294
\label{subsec:DocumentingMacros}

0 commit comments

Comments
 (0)