about summary refs log tree commit diff
path: root/absl/base/log_severity.h
diff options
context:
space:
mode:
authorAbseil Team <absl-team@google.com>2018-04-03T15·59-0700
committerAshley Hedberg <ahedberg@google.com>2018-04-03T18·35-0400
commit0e5c3e8f161c004e3384d7e07eb0e6e0ac834fb6 (patch)
tree6d21de384ce6345ae422e32fbc3ba1ea7461b877 /absl/base/log_severity.h
parent7b3c38a0628b9201ce92a6893b96890b64e5daa8 (diff)
- 7f2f6ad0cc3488cb57dfc5d1050c38862a2e42ef Only check for a specific message in the `bad_cast` tests... by Matt Calabrese <calabrese@google.com>
  - 6a8e56df0d6820c48ee8f39146c7e1fba8a394e7 This prevents a uint32_t value from potentially being log... by Matt Calabrese <calabrese@google.com>
  - 00a77f5569086654837c03d06206349642364395 Add doc-comments to `absl::LogSeverity` and its helpers. by Abseil Team <absl-team@google.com>
  - bf877655e420ebff42bede238523d360b53a80fa Enforce the Abseil-wide assumption that CHAR_BIT == 8. by Mark Barolak <mbar@google.com>

GitOrigin-RevId: 7f2f6ad0cc3488cb57dfc5d1050c38862a2e42ef
Change-Id: Id210255c9301442b0379dca147a806c85452f772
Diffstat (limited to 'absl/base/log_severity.h')
-rw-r--r--absl/base/log_severity.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/absl/base/log_severity.h b/absl/base/log_severity.h
index e146bcb05a49..e2931c34d1df 100644
--- a/absl/base/log_severity.h
+++ b/absl/base/log_severity.h
@@ -22,6 +22,9 @@
 
 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.
 enum class LogSeverity : int {
   kInfo = 0,
   kWarning = 1,
@@ -36,6 +39,8 @@ constexpr std::array<absl::LogSeverity, 4> LogSeverities() {
            absl::LogSeverity::kError, absl::LogSeverity::kFatal}};
 }
 
+// Returns the all-caps std::string representation (e.g. "INFO") of the specified
+// severity level if it is one of the normal levels and "UNKNOWN" otherwise.
 constexpr const char* LogSeverityName(absl::LogSeverity s) {
   return s == absl::LogSeverity::kInfo
              ? "INFO"
@@ -46,7 +51,8 @@ constexpr const char* LogSeverityName(absl::LogSeverity s) {
                          : s == absl::LogSeverity::kFatal ? "FATAL" : "UNKNOWN";
 }
 
-// Note that out-of-range severities normalize to kInfo or kError, never kFatal.
+// Values less than `kInfo` normalize to `kInfo`; values greater than `kFatal`
+// normalize to `kError` (**NOT** `kFatal`).
 constexpr absl::LogSeverity NormalizeLogSeverity(absl::LogSeverity s) {
   return s < absl::LogSeverity::kInfo
              ? absl::LogSeverity::kInfo