Skip to content

Removed doxygen warnings #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ahcorde merged 3 commits into from
Jul 22, 2020
Merged

Removed doxygen warnings #266

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4013c14
Removed doxygen warnings
ahcorde Jul 10, 2020
1a1d0a6
Merge remote-tracking branch 'origin/master' into ahcorde/doxygen/war…
ahcorde Jul 21, 2020
acd35a8
Added feedback
ahcorde Jul 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions include/rcutils/logging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion include/rcutils/strerror.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions include/rcutils/types/string_array.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down