Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Apr 21, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rcl/include/rcl/client.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ rcl_client_init(
* Lock-Free | Yes
*
* \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_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_NODE_INVALID` if the node is invalid, or
Expand Down
9 changes: 7 additions & 2 deletions rcl/include/rcl/node.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,13 @@ rcl_node_init(
* Destroys any automatically created infrastructure and deallocates memory.
* After calling, the rcl_node_t can be safely deallocated.
*
* Any middleware primitives created by the user, e.g. publishers, services, etc.,
* are invalid after deinitialization.
* All middleware primitives created by the user, e.g. publishers, services, etc,
* 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>
* Attribute | Adherence
Expand Down
2 changes: 1 addition & 1 deletion rcl/include/rcl/publisher.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ rcl_publisher_init(
* Lock-Free | Yes
*
* \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_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_PUBLISHER_INVALID` if the publisher is invalid, or
Expand Down
2 changes: 1 addition & 1 deletion rcl/include/rcl/service.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ rcl_service_init(
* Lock-Free | Yes
*
* \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_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_SERVICE_INVALID` if the service is invalid, or
Expand Down
2 changes: 1 addition & 1 deletion rcl/include/rcl/subscription.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ rcl_subscription_init(
* Lock-Free | Yes
*
* \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_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_SUBSCRIPTION_INVALID` if the subscription is invalid, or
Expand Down