From 3b489c1e292083946b731be5efee324b95305c3f Mon Sep 17 00:00:00 2001 From: Michel Hidalgo Date: Mon, 24 Aug 2020 18:13:56 -0300 Subject: [PATCH] Update publisher/subscription QoS query API documentation. (#263) Follow-up after 0176872b10ff502ae34fa3eef5e900145f18b0b3. Signed-off-by: Michel Hidalgo --- rmw/include/rmw/rmw.h | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h index a07107eb..9e6d5c89 100644 --- a/rmw/include/rmw/rmw.h +++ b/rmw/include/rmw/rmw.h @@ -472,14 +472,26 @@ rmw_publisher_count_matched_subscriptions( * depends on the underlying rmw implementation. * If the underlying setting in use can't be represented in ROS terms, * it will be set to RMW_*_UNKNOWN. - * The value of avoid_ros_namespace_conventions field is not resolved - * with this function. The rcl function rcl_publisher_get_actual_qos - * resolves it. + * + * \note The value of avoid_ros_namespace_conventions field is not resolved + * with this function. The rcl function `rcl_publisher_get_actual_qos()` + * resolves it. + * + *
+ * Attribute | Adherence + * ------------------ | ------------- + * Allocates Memory | Maybe [1] + * Thread-Safe | No + * Uses Atomics | Maybe [1] + * Lock-Free | Maybe [1] + * [1] rmw implementation defined, check the implementation documentation * * \param[in] publisher the publisher object to inspect * \param[out] qos the actual qos settings * \return `RMW_RET_OK` if successful, or * \return `RMW_RET_INVALID_ARGUMENT` if either argument is null, or + * \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if publisher + * implementation identifier does not match, or * \return `RMW_RET_ERROR` if an unexpected error occurs. */ RMW_PUBLIC @@ -777,9 +789,19 @@ rmw_subscription_count_matched_publishers( * depends on the underlying rmw implementation. * If the underlying setting in use can't be represented in ROS terms, * it will be set to RMW_*_UNKNOWN. - * The value of avoid_ros_namespace_conventions field is not resolved - * with this function. The rcl function rcl_subscription_get_actual_qos - * resolves it. + * + * \note The value of avoid_ros_namespace_conventions field is not resolved + * with this function. The rcl function `rcl_subscription_get_actual_qos()` + * resolves it. + * + *
+ * Attribute | Adherence + * ------------------ | ------------- + * Allocates Memory | Maybe [1] + * Thread-Safe | No + * Uses Atomics | Maybe [1] + * Lock-Free | Maybe [1] + * [1] rmw implementation defined, check the implementation documentation * * \param[in] subscription the subscription object to inspect * \param[out] qos the actual qos settings