Skip to content

Commit 4418b97

Browse files
committed
DOC: Avoid documenting ivar default values in SpatialFunction class
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.
1 parent cdbbdf9 commit 4418b97

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Modules/Core/Common/include/itkConicShellInteriorExteriorSpatialFunction.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ class ITK_TEMPLATE_EXPORT ConicShellInteriorExteriorSpatialFunction
115115

116116
/** Set/Get direction along the gradient to search.
117117
* Set to true to use the direction that the gradient is pointing;
118-
* set to false for the opposite direction. Default is Off. */
118+
* set to false for the opposite direction. */
119119
itkGetConstMacro(Polarity, bool);
120120
itkSetMacro(Polarity, bool);
121121
itkBooleanMacro(Polarity);

0 commit comments

Comments
 (0)