review: add documentation

inbelic · inbelic · commit 763d4cf42b10 · 2025-08-06T16:38:18.000Z
diff --git a/llvm/include/llvm/Support/ScopedPrinter.h b/llvm/include/llvm/Support/ScopedPrinter.h
@@ -107,6 +107,9 @@ std::string enumToString(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues) {
   return utohexstr(Value, true);
 }
 
+/// Retrieves the Value's enum name.
+///
+/// Returns an empty StringRef when an invalid value is provided.
 template <typename T, typename TEnum>
 StringRef enumToStringRef(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues) {
   for (const EnumEntry<TEnum> &EnumItem : EnumValues)

Original file line number	Diff line number	Diff line change
`@@ -107,6 +107,9 @@ std::string enumToString(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues) {`
`107`	`107`	`return utohexstr(Value, true);`
`108`	`108`	`}`
`109`	`109`
	`110`	`+/// Retrieves the Value's enum name.`
	`111`	`+///`
	`112`	`+/// Returns an empty StringRef when an invalid value is provided.`
`110`	`113`	`template <typename T, typename TEnum>`
`111`	`114`	`StringRef enumToStringRef(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues) {`
`112`	`115`	`for (const EnumEntry<TEnum> &EnumItem : EnumValues)`