From 4013c14a946bdf5d4bc943cdcd538fcea5793899 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Fri, 10 Jul 2020 14:01:06 +0200 Subject: [PATCH 1/2] Removed doxygen warnings Signed-off-by: ahcorde --- include/rcutils/logging.h | 4 ++-- include/rcutils/strerror.h | 2 +- include/rcutils/types/string_array.h | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/include/rcutils/logging.h b/include/rcutils/logging.h index 023f3d5e..768e8059 100644 --- 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 index c1f34432..ed23d269 100644 --- 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 diff --git a/include/rcutils/types/string_array.h b/include/rcutils/types/string_array.h index 743ea9e7..c109dbfe 100644 --- a/include/rcutils/types/string_array.h +++ b/include/rcutils/types/string_array.h @@ -115,8 +115,8 @@ rcutils_string_array_fini(rcutils_string_array_t * string_array); /** * The two string arrays are compared according to lexographical order. * - * \param[in] sa0 The first string array. - * \param[in] sa1 The second string array. + * \param[in] lhs The first string array. + * \param[in] rhs The second string array. * \param[out] res Negative value if `lhs` appears before `rhs` in lexographical order. * Zero if `lhs` and `rhs` are equal. * Positive value if `lhs` appears after `rhs in lexographical order. From acd35a86f0ff7d4384657093e12e827dbe93a83f Mon Sep 17 00:00:00 2001 From: ahcorde Date: Tue, 21 Jul 2020 11:29:53 +0200 Subject: [PATCH 2/2] Added feedback Signed-off-by: ahcorde --- include/rcutils/logging.h | 2 +- include/rcutils/strerror.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/include/rcutils/logging.h b/include/rcutils/logging.h index 768e8059..afd08319 100644 --- a/include/rcutils/logging.h +++ b/include/rcutils/logging.h @@ -501,7 +501,7 @@ RCUTILS_ATTRIBUTE_PRINTF_FORMAT(4, 5); * \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] format The format string - * \param[in] args the `va_list` used by the logger + * \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 index ed23d269..dae10ade 100644 --- a/include/rcutils/strerror.h +++ b/include/rcutils/strerror.h @@ -32,7 +32,7 @@ extern "C" * * This function is thread-safe. * - * \param[inout] 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