From e080db6ec98d70d57968d95f8a1f7ffde674bc95 Mon Sep 17 00:00:00 2001 From: dhood Date: Tue, 7 Nov 2017 12:41:46 -0800 Subject: [PATCH] Document multiple error RC --- include/rcutils/logging.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/rcutils/logging.h b/include/rcutils/logging.h index 3f17cc8c..96ce67dc 100644 --- a/include/rcutils/logging.h +++ b/include/rcutils/logging.h @@ -58,6 +58,7 @@ extern bool g_rcutils_logging_initialized; * \return `RCUTILS_RET_LOGGING_SEVERITY_MAP_INVALID` if the internal logger * severity map cannot be initialized, in which case logger severity * thresholds will not be configurable. + * \return `RCUTILS_RET_MULTIPLE_ERRORS` if multiple errors occur. */ RCUTILS_PUBLIC rcutils_ret_t rcutils_logging_initialize_with_allocator(rcutils_allocator_t allocator); @@ -82,6 +83,7 @@ rcutils_ret_t rcutils_logging_initialize_with_allocator(rcutils_allocator_t allo * \return `RCUTILS_RET_LOGGING_SEVERITY_MAP_INVALID` if the internal logger * severity map cannot be initialized, in which case logger severity * thresholds will not be configurable. + * \return `RCUTILS_RET_MULTIPLE_ERRORS` if multiple errors occur. */ RCUTILS_PUBLIC rcutils_ret_t rcutils_logging_initialize();