[llvm] Fix Doxygen comment (PR #147674)

Glebs Ivanovskis via llvm-commits llvm-commits at lists.llvm.org
Wed Jul 9 01:23:47 PDT 2025


https://github.com/i-ky created https://github.com/llvm/llvm-project/pull/147674

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):

![image](https://github.com/user-attachments/assets/03601ba3-e66d-4c52-b9c6-39f4dd78e558)

>From 400744273af5fa424d928fee5c1dc991218acb53 Mon Sep 17 00:00:00 2001
From: Glebs Ivanovskis <glebs.ivanovskis at zimperium.com>
Date: Wed, 9 Jul 2025 11:21:02 +0300
Subject: [PATCH] Fix Doxygen comment

---
 llvm/include/llvm/Support/ErrorHandling.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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



More information about the llvm-commits mailing list