From 9d9f5c55af95a95a605a3dc321fea158c91d652d Mon Sep 17 00:00:00 2001 From: albert-github Date: Sun, 23 Mar 2025 08:59:22 -0400 Subject: [PATCH] DOC: Grouping shared documentation Written a small item about grouping shared documentation. --- .../Latex/Appendices/CodingStyleGuide.tex | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex index 70f0b5bd..1f190e1a 100644 --- a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex +++ b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex @@ -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 */} +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}