From 89ad4bebbe330a0d7d5003fbf2f2a5e85ea19167 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Wed, 10 Jun 2020 10:52:59 +0200 Subject: [PATCH] Fixed doxygen warnings Signed-off-by: ahcorde --- rcl/include/rcl/arguments.h | 2 +- rcl/include/rcl/event.h | 2 +- rcl/include/rcl/graph.h | 4 ++-- rcl/include/rcl/logging_rosout.h | 3 ++- rcl/include/rcl/node_options.h | 2 +- rcl/include/rcl/remap.h | 2 +- rcl/include/rcl/validate_topic_name.h | 3 +++ rcl/src/rcl/arguments.c | 1 + rcl_action/include/rcl_action/action_client.h | 4 ++-- rcl_action/include/rcl_action/action_server.h | 2 +- rcl_action/include/rcl_action/wait.h | 4 +++- 11 files changed, 18 insertions(+), 11 deletions(-) diff --git a/rcl/include/rcl/arguments.h b/rcl/include/rcl/arguments.h index efdad17e7..f29da70f8 100644 --- a/rcl/include/rcl/arguments.h +++ b/rcl/include/rcl/arguments.h @@ -212,7 +212,7 @@ rcl_arguments_get_count_unparsed_ros( * * \param[in] args An arguments structure that has been parsed. * \param[in] allocator A valid allocator. - * \param[out] output_unparsed_indices An allocated array of indices into the original argv array. + * \param[out] output_unparsed_ros_indices An allocated array of indices into the original argv array. * This array must be deallocated by the caller using the given allocator. * If there are no unparsed ROS specific arguments then the output will be set to NULL. * \return `RCL_RET_OK` if everything goes correctly, or diff --git a/rcl/include/rcl/event.h b/rcl/include/rcl/event.h index 01def23d0..bee14d5ab 100644 --- a/rcl/include/rcl/event.h +++ b/rcl/include/rcl/event.h @@ -109,7 +109,7 @@ rcl_subscription_event_init( /** * Take an event from the event handle. * - * \param[in] event_handle event object to take from + * \param[in] event event object to take from * \param[in, out] event_info event info object to write taken data into * \return `RCL_RET_OK` if successful, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or diff --git a/rcl/include/rcl/graph.h b/rcl/include/rcl/graph.h index ea651f7c2..e4756937d 100644 --- a/rcl/include/rcl/graph.h +++ b/rcl/include/rcl/graph.h @@ -427,7 +427,7 @@ rcl_names_and_types_fini(rcl_names_and_types_t * names_and_types); * \param[in] node the handle to the node being used to query the ROS graph * \param[in] allocator used to control allocation and deallocation of names * \param[out] node_names struct storing discovered node names - * \param[out] node_namesspaces struct storing discovered node namespaces + * \param[out] node_namespaces struct storing discovered node namespaces * \return `RCL_RET_OK` if the query was successful, or * \return `RCL_RET_BAD_ALLOC` if an error occurred while allocating memory, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or @@ -459,7 +459,7 @@ rcl_get_node_names( * \param[in] node the handle to the node being used to query the ROS graph * \param[in] allocator used to control allocation and deallocation of names * \param[out] node_names struct storing discovered node names - * \param[out] node_namesspaces struct storing discovered node namespaces + * \param[out] node_namespaces struct storing discovered node namespaces * \param[out] enclaves struct storing discovered node enclaves * \return `RCL_RET_OK` if the query was successful, or * \return `RCL_RET_BAD_ALLOC` if an error occurred while allocating memory, or diff --git a/rcl/include/rcl/logging_rosout.h b/rcl/include/rcl/logging_rosout.h index 8e6788c92..03f6bc06d 100644 --- a/rcl/include/rcl/logging_rosout.h +++ b/rcl/include/rcl/logging_rosout.h @@ -151,7 +151,8 @@ rcl_logging_rosout_fini_publisher_for_node( * \param[in] severity The severity level * \param[in] name The name of the logger, must be null terminated c string * \param[in] timestamp The timestamp for when the log message was made - * \param[in] log_str The string to be logged + * \param[in] format The list of arguments to insert into the formatted log message + * \param[in] args argument for the string format */ RCL_PUBLIC void rcl_logging_rosout_output_handler( diff --git a/rcl/include/rcl/node_options.h b/rcl/include/rcl/node_options.h index ab10fa533..c9c0edfb0 100644 --- a/rcl/include/rcl/node_options.h +++ b/rcl/include/rcl/node_options.h @@ -116,7 +116,7 @@ rcl_node_options_copy( * Uses Atomics | Yes * Lock-Free | Yes * - * \param[inout] node_options object to be finalized + * \param[inout] options object to be finalized * \return `RCL_RET_OK` if setup is successful, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_ERROR` if an unspecified error occurs. diff --git a/rcl/include/rcl/remap.h b/rcl/include/rcl/remap.h index c13fde8bc..a7b10ea93 100644 --- a/rcl/include/rcl/remap.h +++ b/rcl/include/rcl/remap.h @@ -257,7 +257,7 @@ rcl_remap_node_namespace( * Uses Atomics | No * Lock-Free | Yes * - * \param[in] args The structure to be deallocated. + * \param[in] remap The structure to be deallocated. * \return `RCL_RET_OK` if the memory was successfully freed, or * \return `RCL_RET_INVALID_ARGUMENT` if any function arguments are invalid, or * \return `RCL_RET_ERROR` if an unspecified error occurs. diff --git a/rcl/include/rcl/validate_topic_name.h b/rcl/include/rcl/validate_topic_name.h index 1ebe90ada..ed884ac1f 100644 --- a/rcl/include/rcl/validate_topic_name.h +++ b/rcl/include/rcl/validate_topic_name.h @@ -97,7 +97,10 @@ rcl_validate_topic_name( /// Validate a given topic name. /** * This is an overload with an extra parameter for the length of topic_name. + * \param[in] topic_name the topic name to be validated, must be null terminated * \param[in] topic_name_length The number of characters in topic_name. + * \param[out] validation_result the reason for validation failure, if any + * \param[out] invalid_index index of violation if the input topic is invalid * * \sa rcl_validate_topic_name(const char *, int *, size_t *) */ diff --git a/rcl/src/rcl/arguments.c b/rcl/src/rcl/arguments.c index b94aa485a..cc2b46fc5 100644 --- a/rcl/src/rcl/arguments.c +++ b/rcl/src/rcl/arguments.c @@ -177,6 +177,7 @@ _rcl_parse_external_log_config_file( * The syntax of the file name is not validated. * \param[in] arg the argument to parse * \param[in] allocator an allocator to use + * \param[in] params points to the populated parameter struct * \param[in,out] param_file string that could be a parameter file name * \return RCL_RET_OK if the rule was parsed correctly, or * \return RCL_RET_BAD_ALLOC if an allocation failed, or diff --git a/rcl_action/include/rcl_action/action_client.h b/rcl_action/include/rcl_action/action_client.h index 0885368bd..c23efb578 100644 --- a/rcl_action/include/rcl_action/action_client.h +++ b/rcl_action/include/rcl_action/action_client.h @@ -548,7 +548,7 @@ rcl_action_send_result_request( * * \param[in] action_client handle to the client that will take the result response * \param[out] response_header pointer to the result response header - * \param[out] ros_result_response preallocated, zero-initialized, struct where the ROS + * \param[out] ros_result preallocated, zero-initialized, struct where the ROS * result message is copied. * \return `RCL_RET_OK` if the response was taken successfully, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or @@ -639,7 +639,7 @@ rcl_action_send_cancel_request( * Lock-Free | Yes * * \param[in] action_client handle to the client that will take the cancel response - * \param[out] request_header pointer to the cancel response header + * \param[out] response_header pointer to the cancel response header * \param[out] ros_cancel_response a zero-initialized ROS cancel response message where * the cancel response is copied. * \return `RCL_RET_OK` if the response was taken successfully, or diff --git a/rcl_action/include/rcl_action/action_server.h b/rcl_action/include/rcl_action/action_server.h index 4f43667c0..df5b4fb6b 100644 --- a/rcl_action/include/rcl_action/action_server.h +++ b/rcl_action/include/rcl_action/action_server.h @@ -712,7 +712,7 @@ rcl_action_take_cancel_request( * * \param[in] action_server handle to the action server that will process the cancel request * \param[in] cancel_request a C-typed ROS cancel request to process - * \param[out] cancel_reponse a zero-initialized cancel response struct + * \param[out] cancel_response a zero-initialized cancel response struct * where the goal info of goals which should be cancelled are copied * \return `RCL_RET_OK` if the response was sent successfully, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or diff --git a/rcl_action/include/rcl_action/wait.h b/rcl_action/include/rcl_action/wait.h index b2d707a09..29bdeb341 100644 --- a/rcl_action/include/rcl_action/wait.h +++ b/rcl_action/include/rcl_action/wait.h @@ -208,10 +208,11 @@ rcl_action_server_wait_set_get_num_entities( * Uses Atomics | No * Lock-Free | Yes * + * \param[in] wait_set struct where action server services are to be stored * \param[in] action_client an action client to query * \param[out] is_feedback_ready `true` if there is a feedback message ready to take, * `false` otherwise - * \param[out] is_status_message `true` if there is a status message ready to take, + * \param[out] is_status_ready `true` if there is a status message ready to take, * `false` otherwise * \param[out] is_goal_response_ready `true` if there is a goal response message ready * to take, `false` otherwise @@ -251,6 +252,7 @@ rcl_action_client_wait_set_get_entities_ready( * Uses Atomics | No * Lock-Free | Yes * + * \param[in] wait_set struct where action server services are to be stored * \param[in] action_server an action server to query * \param[out] is_goal_request_ready `true` if there is a goal request message ready * to take, `false` otherwise