Skip to content

Commit 8674a60

Browse files
author
Alex MacLean
committed
Add documentation about to logging.h.
Signed-off-by: Alex MacLean <macleale@amazon.com>
1 parent a728158 commit 8674a60

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

include/rcutils/logging.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ rcutils_ret_t rcutils_logging_allocator_initialize(
9090
* - `message`, the message string after it has been formatted
9191
* - `name`, the full logger name
9292
* - `severity`, the name of the severity level, e.g. `INFO`
93+
* - `severity_with_color`, the name of the severity level with colours. If the
94+
* `RCUTILS_COLORIZED_OUTPUT` environment variable is set to `1`, `severity_with_color` is
95+
* the same as `severity`.
9396
* - `time`, the timestamp of log message in floating point seconds
9497
* - `time_as_nanoseconds`, the timestamp of log message in integer nanoseconds
9598
*

0 commit comments

Comments
 (0)