[llvm] Fix Doxygen comment (PR #147674)
via llvm-commits
llvm-commits at lists.llvm.org
Wed Jul 9 01:24:19 PDT 2025
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-llvm-support
Author: Glebs Ivanovskis (i-ky)
<details>
<summary>Changes</summary>
One line in Doxygen comment block is a regular `//` comment and is skipped by Doxygen leading to a phrase missing from resulting [documentation](https://llvm.org/doxygen/llvm_2Support_2ErrorHandling_8h.html#ace243f5c25697a1107cce46626b3dc94):

---
Full diff: https://github.com/llvm/llvm-project/pull/147674.diff
1 Files Affected:
- (modified) llvm/include/llvm/Support/ErrorHandling.h (+1-1)
``````````diff
diff --git a/llvm/include/llvm/Support/ErrorHandling.h b/llvm/include/llvm/Support/ErrorHandling.h
index 4c17b6e83acd2..e0f22b9d1358c 100644
--- a/llvm/include/llvm/Support/ErrorHandling.h
+++ b/llvm/include/llvm/Support/ErrorHandling.h
@@ -155,7 +155,7 @@ LLVM_ABI void install_out_of_memory_new_handler();
/// support such hints, prints a reduced message instead and aborts the
/// program.
/// * When "OFF", a builtin_trap is emitted instead of an
-// optimizer hint or printing a reduced message.
+/// optimizer hint or printing a reduced message.
///
/// Use this instead of assert(0). It conveys intent more clearly, suppresses
/// diagnostics for unreachable code paths, and allows compilers to omit
``````````
</details>
https://github.com/llvm/llvm-project/pull/147674
More information about the llvm-commits
mailing list