summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Tom Manshreck <shreck@google.com>2023-01-18 09:44:37 -0800
committerGravatar Copybara-Service <copybara-worker@google.com>2023-01-18 09:45:17 -0800
commit857325a937efa2996c691d6bdcdec8605472e638 (patch)
tree851000ec8ed3e77f8301e1f2a4ad63b747a46f96
parenta86f1cec941ee7842a2ce1bce1cc4aa83eeb8d8d (diff)
Clarify contract of AlphaNum as only a function parameter type
PiperOrigin-RevId: 502901875 Change-Id: I1c8c097e5c81a9e413692109ebfe0d0b24f50f2e
-rw-r--r--absl/strings/str_cat.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/absl/strings/str_cat.h b/absl/strings/str_cat.h
index 5ee26db0..730b4d8c 100644
--- a/absl/strings/str_cat.h
+++ b/absl/strings/str_cat.h
@@ -242,8 +242,10 @@ struct Dec {
// -----------------------------------------------------------------------------
//
// The `AlphaNum` class acts as the main parameter type for `StrCat()` and
-// `StrAppend()`, providing efficient conversion of numeric, boolean, and
-// hexadecimal values (through the `Hex` type) into strings.
+// `StrAppend()`, providing efficient conversion of numeric, boolean, decimal,
+// and hexadecimal values (through the `Dec` and `Hex` types) into strings.
+// `AlphaNum` should only be used as a function parameter. Do not instantiate
+// `AlphaNum` directly as a stack variable.
class AlphaNum {
public: