added the API documentation of the new get_node_options method

ros-controls · Jan 14, 2024 · f36675e · f36675e
1 parent 59732a9
commit f36675e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/controller_interface/include/controller_interface/controller_interface_base.hpp b/controller_interface/include/controller_interface/controller_interface_base.hpp
@@ -158,6 +158,12 @@ class ControllerInterfaceBase : public rclcpp_lifecycle::node_interfaces::Lifecy
   CONTROLLER_INTERFACE_PUBLIC
   const std::string & get_robot_description() const;
 
+  /**
+   * Method used by the `init` method to instantiate the Lifecycle node of the controller upon
+   * loading the controller
+   *
+   * @returns NodeOptions required for the configuration of the controller lifecycle node
+   */
   CONTROLLER_INTERFACE_PUBLIC
   virtual rclcpp::NodeOptions get_node_options() const
   {