niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix doc strings (#557)

Browse source 
Signed-off-by: Miaofei <miaofei@amazon.com>
This commit is contained in:
Miaofei Mei 2020-01-20 11:25:55 -08:00 • committed by Ivan Santiago Paunovic
parent 2221d6374e
commit 76b0d5dc34
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
rcl/include/rcl/graph.h
View file

@ -567,7 +567,8 @@ rcl_count_subscribers(
* \param[in] allocator allocator to be used when allocating space for
* the array inside publishers_info
* \param[in] topic_name the name of the topic in question
* \param[in] no_mangle if true, the topic_name will be expanded to its fully qualified name
* \param[in] no_mangle if `true`, `topic_name` needs to be a valid middleware topic name,
* otherwise it should be a valid ROS topic name
* \param[out] publishers_info a struct representing a list of publisher information
* \return `RCL_RET_OK` if the query was successful, or
* \return `RCL_RET_NODE_INVALID` if the node is invalid, or
@ -627,7 +628,8 @@ rcl_get_publishers_info_by_topic(
* \param[in] allocator allocator to be used when allocating space for
* the array inside publishers_info
* \param[in] topic_name the name of the topic in question
* \param[in] no_mangle if true, the topic_name will be expanded to its fully qualified name
* \param[in] no_mangle if `true`, `topic_name` needs to be a valid middleware topic name,
* otherwise it should be a valid ROS topic name
* \param[out] subscriptions_info a struct representing a list of subscriptions information
* \return `RCL_RET_OK` if the query was successful, or
* \return `RCL_RET_NODE_INVALID` if the node is invalid, or