Skip to content

Commit 6a2861a

Browse files
committed
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.
1 parent a7f818b commit 6a2861a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4203,7 +4203,7 @@ \subsection{Documenting Data Members}
42034203
\begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{cpp}
42044204
/** Set/Get direction along the gradient to search.
42054205
* Set to true to use the direction that the gradient is pointing;
4206-
* set to false for the opposite direction. Default is Off. */
4206+
* set to false for the opposite direction. */
42074207
itkGetConstMacro(Polarity, bool);
42084208
itkSetMacro(Polarity, bool);
42094209
itkBooleanMacro(Polarity);

0 commit comments

Comments
 (0)