Document multiple error RC

ros2 · Nov 7, 2017 · e080db6 · e080db6
1 parent afd6c3e
commit e080db6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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();