Skip to content

Commit 694da1e

Browse files
committed
Added comments to the has_logging_interface and has_parameter_interface methods
1 parent 4e9b20f commit 694da1e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

joint_limits/include/joint_limits/joint_limiter_interface.hpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,11 +238,17 @@ class JointLimiterInterface
238238

239239
/** \brief Checks if the logging interface is set.
240240
* \returns true if the logging interface is available, otherwise false.
241+
*
242+
* \note this way of interfacing would be useful for instances where the logging interface is not
243+
* available, for example in the ResourceManager or ResourceStorage classes.
241244
*/
242245
bool has_logging_interface() const { return node_logging_itf_ != nullptr; }
243246

244247
/** \brief Checks if the parameter interface is set.
245248
* \returns true if the parameter interface is available, otherwise false.
249+
*
250+
* * \note this way of interfacing would be useful for instances where the logging interface is
251+
* not available, for example in the ResourceManager or ResourceStorage classes.
246252
*/
247253
bool has_parameter_interface() const { return node_param_itf_ != nullptr; }
248254

0 commit comments

Comments
 (0)