Skip to content

Commit

Permalink
Update publisher/subscription QoS query API documentation. (#263)
Browse files Browse the repository at this point in the history
Follow-up after 0176872.

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
  • Loading branch information
hidmic authored and ahcorde committed Oct 13, 2020
1 parent 10d7f0a commit 3b489c1
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions rmw/include/rmw/rmw.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | Maybe [1]
* Thread-Safe | No
* Uses Atomics | Maybe [1]
* Lock-Free | Maybe [1]
* <i>[1] rmw implementation defined, check the implementation documentation</i>
*
* \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
Expand Down Expand Up @@ -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.
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | Maybe [1]
* Thread-Safe | No
* Uses Atomics | Maybe [1]
* Lock-Free | Maybe [1]
* <i>[1] rmw implementation defined, check the implementation documentation</i>
*
* \param[in] subscription the subscription object to inspect
* \param[out] qos the actual qos settings
Expand Down

0 comments on commit 3b489c1

Please sign in to comment.