Removed doxygen warnings (#266) (#271)

* Removed doxygen warnings Signed-off-by: ahcorde <ahcorde@gmail.com> * Added feedback Signed-off-by: ahcorde <ahcorde@gmail.com>
ros2 · Jul 28, 2020 · dfe8077 · dfe8077
1 parent 9558a3f
commit dfe8077
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/include/rcutils/logging.h b/include/rcutils/logging.h
@@ -272,7 +272,6 @@ void rcutils_logging_set_output_handler(rcutils_logging_output_handler_t functio
  * \param[in] name The name of the logger that this message came from
  * \param[in] timestamp The time at which the log message was generated
  * \param[in] msg The message being logged
- * \param[in] args The list of arguments to insert into the formatted log message
  * \param[out] logging_output An output buffer for the formatted message
  */
 RCUTILS_PUBLIC
@@ -501,7 +500,8 @@ RCUTILS_ATTRIBUTE_PRINTF_FORMAT(4, 5);
  * \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 format string
+ * \param[in] args The `va_list` used by the logger
  */
 RCUTILS_PUBLIC
 void rcutils_logging_console_output_handler(

diff --git a/include/rcutils/strerror.h b/include/rcutils/strerror.h
@@ -32,7 +32,7 @@ extern "C"
  *
  * This function is thread-safe.
  *
- * \param[in/out] buffer the buffer in which to store the data
+ * \param[inout] buffer The buffer in which to store the data
  * \param[in] buffer_length the maximum length of the buffer
  */
 RCUTILS_PUBLIC