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

fix typo

Browse source
This commit is contained in:
William Woodall 2016-05-02 19:00:08 -07:00
parent 2c33b23589
commit a01943973a
4 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -72,7 +72,7 @@ rcl_get_zero_initialized_guard_condition(void);
* \param[in] options the guard_condition's options * \param[in] options the guard_condition's options
* \return RCL_RET_OK if guard_condition was initialized successfully, or * \return RCL_RET_OK if guard_condition was initialized successfully, or
* RCL_RET_ALREADY_INIT if the guard condition is already initialized, or * RCL_RET_ALREADY_INIT if the guard condition is already initialized, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_BAD_ALLOC if allocating memory failed, or * RCL_RET_BAD_ALLOC if allocating memory failed, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
@ -93,7 +93,7 @@ rcl_guard_condition_init(
* *
* \param[inout] guard_condition handle to the guard_condition to be finalized * \param[inout] guard_condition handle to the guard_condition to be finalized
* \return RCL_RET_OK if guard_condition was finalized successfully, or * \return RCL_RET_OK if guard_condition was finalized successfully, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
RCL_PUBLIC RCL_PUBLIC
@ -125,7 +125,7 @@ rcl_guard_condition_get_default_options(void);
* *
* \param[in] guard_condition handle to the guard_condition to be triggered * \param[in] guard_condition handle to the guard_condition to be triggered
* \return RCL_RET_OK if the guard condition was triggered, or * \return RCL_RET_OK if the guard condition was triggered, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
RCL_PUBLIC RCL_PUBLIC

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

@ -106,7 +106,7 @@ rcl_get_zero_initialized_node(void);
* \param[in] options the node options; pass null to use default options * \param[in] options the node options; pass null to use default options
* \return RCL_RET_OK if node was initialized successfully, or * \return RCL_RET_OK if node was initialized successfully, or
* RCL_RET_ALREADY_INIT if the node has already be initialized, or * RCL_RET_ALREADY_INIT if the node has already be initialized, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_BAD_ALLOC if allocating memory failed, or * RCL_RET_BAD_ALLOC if allocating memory failed, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
@ -129,7 +129,7 @@ rcl_node_init(rcl_node_t * node, const char * name, const rcl_node_options_t * o
* *
* \param[in] node handle to the node to be finalized * \param[in] node handle to the node to be finalized
* \return RCL_RET_OK if node was finalized successfully, or * \return RCL_RET_OK if node was finalized successfully, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
RCL_PUBLIC RCL_PUBLIC
@ -205,7 +205,7 @@ rcl_node_get_options(const rcl_node_t * node);
* \param[in] node the handle to the node being queried * \param[in] node the handle to the node being queried
* \return RCL_RET_OK if node the domain ID was retrieved successfully, or * \return RCL_RET_OK if node the domain ID was retrieved successfully, or
* RCL_RET_NODE_INVALID if the node is invalid, or * RCL_RET_NODE_INVALID if the node is invalid, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
RCL_PUBLIC RCL_PUBLIC

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

@ -122,7 +122,7 @@ rcl_get_zero_initialized_service(void);
* \param[in] service_name the name of the service * \param[in] service_name the name of the service
* \param[in] options service options, including quality of service settings * \param[in] options service options, including quality of service settings
* \return RCL_RET_OK if service was initialized successfully, or * \return RCL_RET_OK if service was initialized successfully, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_BAD_ALLOC if allocating memory failed, or * RCL_RET_BAD_ALLOC if allocating memory failed, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
@ -150,7 +150,7 @@ rcl_service_init(
* \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 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
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
RCL_PUBLIC RCL_PUBLIC
@ -192,7 +192,7 @@ rcl_service_get_default_options(void);
* \param[inout] request_header ptr to the struct holding metadata about the request ID * \param[inout] request_header ptr to the struct holding metadata about the request ID
* \param[inout] ros_request type-erased ptr to an allocated ROS request message * \param[inout] ros_request type-erased ptr to an allocated ROS request message
* \return RCL_RET_OK if the request was taken, or * \return RCL_RET_OK if the request was taken, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_SERVICE_INVALID if the service is invalid, or * RCL_RET_SERVICE_INVALID if the service is invalid, or
* RCL_RET_BAD_ALLOC if allocating memory failed, or * RCL_RET_BAD_ALLOC if allocating memory failed, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.

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

@ -124,7 +124,7 @@ rcl_get_zero_initialized_subscription(void);
* \param[in] topic_name the name of the topic * \param[in] topic_name the name of the topic
* \param[in] options subscription options, including quality of service settings * \param[in] options subscription options, including quality of service settings
* \return RCL_RET_OK if subscription was initialized successfully, or * \return RCL_RET_OK if subscription was initialized successfully, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_BAD_ALLOC if allocating memory failed, or * RCL_RET_BAD_ALLOC if allocating memory failed, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
@ -152,7 +152,7 @@ rcl_subscription_init(
* \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 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
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_ERROR if an unspecified error occurs. * RCL_RET_ERROR if an unspecified error occurs.
*/ */
RCL_PUBLIC RCL_PUBLIC
@ -203,7 +203,7 @@ rcl_subscription_get_default_options(void);
* \param[out] taken pointer to a bool, if set to false a message was not taken * \param[out] taken pointer to a bool, if set to false a message was not taken
* \param[out] message_info rmw struct which contains meta-data for the message * \param[out] message_info rmw struct which contains meta-data for the message
* \return RCL_RET_OK if the message was published, or * \return RCL_RET_OK if the message was published, or
* RCL_RET_INVALID_ARGUMENT if any arugments are invalid, or * RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
* RCL_RET_SUBSCRIPTION_INVALID if the subscription is invalid, or * RCL_RET_SUBSCRIPTION_INVALID if the subscription is invalid, or
* RCL_RET_BAD_ALLOC if allocating memory failed, or * RCL_RET_BAD_ALLOC if allocating memory failed, or
* RCL_RET_SUBSCRIPTION_TAKE_FAILED if take failed but no error * RCL_RET_SUBSCRIPTION_TAKE_FAILED if take failed but no error