added explanatory comment about ignored default parameters

teamspatzenhirn · Aug 27, 2023 · 8438d59 · 8438d59
1 parent f22dcdc
commit 8438d59
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/include/service_wrapper.hpp b/include/service_wrapper.hpp
@@ -31,8 +31,16 @@ struct FutureTimeoutContainer {
     bool timeoutReached = false;
 };
 
+/**
+ * Utility class wrapping all the ROS related calls.
+ */
 class ServiceWrapper {
   public:
+    /**
+     * Constructor.
+     * @param ignoreDefaultParameters_ Decides, whether the default parameters (like 'use_sim_time') are ignored
+     *                                 within the visualization.
+     */
     explicit ServiceWrapper(bool ignoreDefaultParameters_ = true);
 
     void terminate();