Skip to content

Commit

Permalink
DOC: Avoid documenting ivar default values in SpatialFunction class
Browse files Browse the repository at this point in the history
Avoid documenting ivar default values in
`itk::ConicShellInteriorExteriorSpatialFunction` 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 cdbbdf9 commit 4418b97
Showing 1 changed file with 1 addition and 1 deletion.
Expand Up @@ -115,7 +115,7 @@ class ITK_TEMPLATE_EXPORT ConicShellInteriorExteriorSpatialFunction

/** 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 4418b97

Please sign in to comment.