[Backport Dashing] Fixed doxygen warnings (#677) (#702)

Signed-off-by: ahcorde <[email protected]>

Author: ahcorde

rcl/include/rcl/event.h

@@ -103,7 +103,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
  * \param[in, out] taken boolean flag indicating if an event was taken or not
  * \return `RCL_RET_OK` if successful, or

rcl/include/rcl/graph.h

@@ -361,8 +361,8 @@ 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_names struct storing discovered node names
+ * \param[out] node_namespaces struct storing discovered node namespaces
  * \return `RCL_RET_OK` if the query was successful, or
  * \return `RCL_RET_ERROR` if an unspecified error occurs.
  */

rcl/include/rcl/logging_rosout.h

@@ -152,7 +152,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(

rcl/include/rcl/node_options.h

@@ -110,7 +110,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.

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.

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 *)
  */

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

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

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