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

Doc rcl_pub/etc_fini() must come before rcl_node_fini() (#625)

Browse source 
Signed-off-by: Shane Loretz <sloretz@osrfoundation.org>
This commit is contained in:
Shane Loretz 2020-04-20 23:34:01 -04:00 • committed by GitHub
parent 0a795cc776
commit 40f6a63310
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
rcl/include/rcl/client.h
View file

@ -174,7 +174,7 @@ rcl_client_init(
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[inout] client handle to the client to be finalized * \param[inout] client handle to the client to be finalized
* \param[in] node handle to the node used to create the client * \param[in] node a valid (not finalized) handle to the node used to create the client
* \return `RCL_RET_OK` if client was finalized successfully, or * \return `RCL_RET_OK` if client was finalized successfully, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_NODE_INVALID` if the node is invalid, or * \return `RCL_RET_NODE_INVALID` if the node is invalid, or

9
rcl/include/rcl/node.h
View file

@ -153,8 +153,13 @@ rcl_node_init(
* Destroys any automatically created infrastructure and deallocates memory. * Destroys any automatically created infrastructure and deallocates memory.
* After calling, the rcl_node_t can be safely deallocated. * After calling, the rcl_node_t can be safely deallocated.
* *
* Any middleware primitives created by the user, e.g. publishers, services, etc., * All middleware primitives created by the user, e.g. publishers, services, etc,
* are invalid after deinitialization. * which were created from this node must be finalized using their respective
* `rcl_*_fini()` functions before this is called.
* \sa rcl_publisher_fini()
* \sa rcl_subscription_fini()
* \sa rcl_client_fini()
* \sa rcl_service_fini()
* *
* <hr> * <hr>
* Attribute | Adherence * Attribute | Adherence

2
rcl/include/rcl/publisher.h
View file

@ -172,7 +172,7 @@ rcl_publisher_init(
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[inout] publisher handle to the publisher to be finalized * \param[inout] publisher handle to the publisher to be finalized
* \param[in] node handle to the node used to create the publisher * \param[in] node a valid (not finalized) handle to the node used to create the publisher
* \return `RCL_RET_OK` if publisher was finalized successfully, or * \return `RCL_RET_OK` if publisher was finalized successfully, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_PUBLISHER_INVALID` if the publisher is invalid, or * \return `RCL_RET_PUBLISHER_INVALID` if the publisher is invalid, or

2
rcl/include/rcl/service.h
View file

@ -173,7 +173,7 @@ rcl_service_init(
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[inout] service handle to the service to be deinitialized * \param[inout] service handle to the service to be deinitialized
* \param[in] node handle to the node used to create the service * \param[in] node a valid (not finalized) handle to the node used to create the service
* \return `RCL_RET_OK` if service was deinitialized successfully, or * \return `RCL_RET_OK` if service was deinitialized successfully, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_SERVICE_INVALID` if the service is invalid, or * \return `RCL_RET_SERVICE_INVALID` if the service is invalid, or

2
rcl/include/rcl/subscription.h
View file

@ -175,7 +175,7 @@ rcl_subscription_init(
* Lock-Free | Yes * Lock-Free | Yes
* *
* \param[inout] subscription handle to the subscription to be deinitialized * \param[inout] subscription handle to the subscription to be deinitialized
* \param[in] node handle to the node used to create the subscription * \param[in] node a valid (not finalized) handle to the node used to create the subscription
* \return `RCL_RET_OK` if subscription was deinitialized successfully, or * \return `RCL_RET_OK` if subscription was deinitialized successfully, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_SUBSCRIPTION_INVALID` if the subscription is invalid, or * \return `RCL_RET_SUBSCRIPTION_INVALID` if the subscription is invalid, or