From 4418b97f567c6b307ce74f7d7a2134e47485fa29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Sun, 16 Jul 2023 17:37:16 -0400 Subject: [PATCH] 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. --- .../include/itkConicShellInteriorExteriorSpatialFunction.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Modules/Core/Common/include/itkConicShellInteriorExteriorSpatialFunction.h b/Modules/Core/Common/include/itkConicShellInteriorExteriorSpatialFunction.h index 3e84c532296..54a113c38be 100644 --- a/Modules/Core/Common/include/itkConicShellInteriorExteriorSpatialFunction.h +++ b/Modules/Core/Common/include/itkConicShellInteriorExteriorSpatialFunction.h @@ -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);