From 6a2861ae6c5df27e8eda12493bbb6af47c355a31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Sun, 16 Jul 2023 17:16:26 -0400 Subject: [PATCH] DOC: Avoid documenting ivar default values Avoid documenting ivar default values since: - All ivar values should be initialized to some default value. - When default values are changed, it is easy to forget about updating the documentation and making it inconsistent with the actual value in the code. --- SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex index 30c9ff84..6e55600f 100644 --- a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex +++ b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex @@ -4203,7 +4203,7 @@ \subsection{Documenting Data Members} \begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{cpp} /** Set/Get direction along the gradient to search. * Set to true to use the direction that the gradient is pointing; - * set to false for the opposite direction. Default is Off. */ + * set to false for the opposite direction. */ itkGetConstMacro(Polarity, bool); itkSetMacro(Polarity, bool); itkBooleanMacro(Polarity);