Update dwb_local_planner.hpp (#2533)

Add remarks
ros-navigation · Sep 14, 2021 · 88b98e7 · 88b98e7
1 parent 168a92d
commit 88b98e7
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/nav2_dwb_controller/dwb_core/include/dwb_core/dwb_local_planner.hpp b/nav2_dwb_controller/dwb_core/include/dwb_core/dwb_local_planner.hpp
@@ -73,10 +73,21 @@ class DWBLocalPlanner : public nav2_core::Controller
 
   virtual ~DWBLocalPlanner() {}
 
+  /**
+   * @brief Activate lifecycle node
+   */
   void activate() override;
+
+  /**
+   * @brief Deactivate lifecycle node
+   */
   void deactivate() override;
-  void cleanup() override;
 
+  /**
+   * @brief Cleanup lifecycle node
+   */
+  void cleanup() override;
+
   /**
    * @brief nav2_core setPlan - Sets the global plan
    * @param path The global plan