Update rclcpp/include/rclcpp/node.hpp

kenji-miyake · aprotyas · mergify-bot · commit f16ce6ddebd6 · 2021-12-08T05:05:47.000Z
Co-authored-by: Abrar Rahman Protyasha &lt;aprotyas@u.rochester.edu&gt;

Update rclcpp/include/rclcpp/node.hpp

Co-authored-by: Abrar Rahman Protyasha &lt;aprotyas@u.rochester.edu&gt;
Signed-off-by: Kenji Miyake &lt;kenji.miyake@tier4.jp&gt;
diff --git a/rclcpp/include/rclcpp/node.hpp b/rclcpp/include/rclcpp/node.hpp
@@ -720,10 +720,9 @@ class Node : public std::enable_shared_from_this<Node>
     ParameterT & parameter,
     const ParameterT & alternative_value) const;
 
-  /// Get the parameter value, or the "alternative_value" if not set, and assign it to "parameter".
+  /// Return the parameter value, or the "alternative_value" if not set.
   /**
-   * If the parameter was not set, then the "parameter" argument is assigned
-   * the "alternative_value".
+   * If the parameter was not set, then the "alternative_value" argument is returned.
    *
    * This method will not throw the rclcpp::exceptions::ParameterNotDeclaredException exception.
    *

Original file line number	Diff line number	Diff line change
`@@ -720,10 +720,9 @@ class Node : public std::enable_shared_from_this<Node>`
`720`	`720`	`ParameterT & parameter,`
`721`	`721`	`const ParameterT & alternative_value) const;`
`722`	`722`
`723`		`- /// Get the parameter value, or the "alternative_value" if not set, and assign it to "parameter".`
	`723`	`+ /// Return the parameter value, or the "alternative_value" if not set.`
`724`	`724`	`/**`
`725`		`- * If the parameter was not set, then the "parameter" argument is assigned`
`726`		`- * the "alternative_value".`
	`725`	`+ * If the parameter was not set, then the "alternative_value" argument is returned.`
`727`	`726`	`*`
`728`	`727`	`* This method will not throw the rclcpp::exceptions::ParameterNotDeclaredException exception.`
`729`	`728`	`*`