Skip to content

Commit

Permalink
DOC: Avoid documenting ivar default values
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jhlegarreta committed Jul 16, 2023
1 parent a7f818b commit 6a2861a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex
Expand Up @@ -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);
Expand Down

0 comments on commit 6a2861a

Please sign in to comment.