Document Logger.hpp: Add Doxygen documentation for Logger class and macros#2
Document Logger.hpp: Add Doxygen documentation for Logger class and macros#2
Conversation
Co-authored-by: rzblue <13878527+rzblue@users.noreply.github.com>
| const char* msg); | ||
|
|
||
| /** | ||
| * Logs a formatted message using fmt format string. |
There was a problem hiding this comment.
| * Logs a formatted message using fmt format string. | |
| * Logs a formatted message using a format string. |
There was a problem hiding this comment.
Updated to "Logs a formatted message using a format string." in 8b5d358
| * @param level Log level | ||
| * @param file Source file name | ||
| * @param line Line number in source file | ||
| * @param format Format string (fmt syntax) |
There was a problem hiding this comment.
| * @param format Format string (fmt syntax) | |
| * @param format Format string |
| * | ||
| * Example: | ||
| * @code | ||
| * Logger logger{[](unsigned int level, const char* file, unsigned int line, |
There was a problem hiding this comment.
Remove the example here, put it in the class level documentation
There was a problem hiding this comment.
Moved example to class level documentation in 8b5d358
| /** | ||
| * Logs a message. | ||
| * | ||
| * This is the core logging function that calls the registered logger |
There was a problem hiding this comment.
| * This is the core logging function that calls the registered logger | |
| * This is the main logging function that calls the registered logger |
There was a problem hiding this comment.
Updated to "This is the main logging function that calls the registered logger" in 8b5d358
| /** | ||
| * Logs a message. | ||
| * | ||
| * This is the core logging function that calls the registered logger |
There was a problem hiding this comment.
Add note to both this and LogV that users should generally use the log macros instead
Co-authored-by: rzblue <13878527+rzblue@users.noreply.github.com>
|
@copilot Any changes suggested in the last review should be applied to other functions if applicable |
…ions and macros Co-authored-by: rzblue <13878527+rzblue@users.noreply.github.com>
Applied the format string documentation changes consistently to:
Changed "fmt format string" to "a format string" and "Format string (fmt syntax)" to "Format string" throughout. See commit dac3c25 |
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.