Added comments to the has_logging_interface and has_parameter_interfa…

…ce methods
pal-robotics-forks · Apr 16, 2024 · 694da1e · 694da1e
1 parent 4e9b20f
commit 694da1e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/joint_limits/include/joint_limits/joint_limiter_interface.hpp b/joint_limits/include/joint_limits/joint_limiter_interface.hpp
@@ -238,11 +238,17 @@ class JointLimiterInterface
 
   /** \brief Checks if the logging interface is set.
    * \returns true if the logging interface is available, otherwise false.
+   *
+   * \note this way of interfacing would be useful for instances where the logging interface is not
+   * available, for example in the ResourceManager or ResourceStorage classes.
    */
   bool has_logging_interface() const { return node_logging_itf_ != nullptr; }
 
   /** \brief Checks if the parameter interface is set.
    * \returns true if the parameter interface is available, otherwise false.
+   *
+   * * \note this way of interfacing would be useful for instances where the logging interface is
+   * not available, for example in the ResourceManager or ResourceStorage classes.
    */
   bool has_parameter_interface() const { return node_param_itf_ != nullptr; }