about summary refs log tree commit diff
path: root/absl/base/log_severity.h
diff options
context:
space:
mode:
Diffstat (limited to 'absl/base/log_severity.h')
-rw-r--r--absl/base/log_severity.h17
1 files changed, 15 insertions, 2 deletions
diff --git a/absl/base/log_severity.h b/absl/base/log_severity.h
index 5a1d5576ce7b..f5dc7d266120 100644
--- a/absl/base/log_severity.h
+++ b/absl/base/log_severity.h
@@ -25,6 +25,19 @@ namespace absl {
 // Four severity levels are defined.  Logging APIs should terminate the program
 // when a message is logged at severity `kFatal`; the other levels have no
 // special semantics.
+//
+// Abseil flags may be defined with type `LogSeverity`.  Dependency layering
+// constraints require that the `AbslParseFlag` overload be declared and defined
+// in the flags module rather than here.  The `AbslUnparseFlag` overload is
+// defined there too for consistency.
+//
+// The parser accepts arbitrary integers (as if the type were `int`).  It also
+// accepts each named enumerator, without regard for case, with or without the
+// leading 'k'.  For example: "kInfo", "INFO", and "info" all parse to the value
+// `absl::LogSeverity::kInfo`.
+//
+// Unparsing a flag produces the same result as `absl::LogSeverityName()` for
+// the standard levels and a base-ten integer otherwise.
 enum class LogSeverity : int {
   kInfo = 0,
   kWarning = 1,
@@ -40,7 +53,7 @@ constexpr std::array<absl::LogSeverity, 4> LogSeverities() {
 }
 
 // Returns the all-caps string representation (e.g. "INFO") of the specified
-// severity level if it is one of the normal levels and "UNKNOWN" otherwise.
+// severity level if it is one of the standard levels and "UNKNOWN" otherwise.
 constexpr const char* LogSeverityName(absl::LogSeverity s) {
   return s == absl::LogSeverity::kInfo
              ? "INFO"
@@ -59,7 +72,7 @@ constexpr absl::LogSeverity NormalizeLogSeverity(absl::LogSeverity s) {
              : s > absl::LogSeverity::kFatal ? absl::LogSeverity::kError : s;
 }
 constexpr absl::LogSeverity NormalizeLogSeverity(int s) {
-  return NormalizeLogSeverity(static_cast<absl::LogSeverity>(s));
+  return absl::NormalizeLogSeverity(static_cast<absl::LogSeverity>(s));
 }
 
 // The exact representation of a streamed `absl::LogSeverity` is deliberately