Skip to content

Fix Doxygen comment #147674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix Doxygen comment #147674

wants to merge 1 commit into from

Conversation

i-ky
Copy link
Contributor

@i-ky i-ky commented Jul 9, 2025

One line in Doxygen comment block is a regular // comment and is skipped by Doxygen leading to a phrase ("optimizer hint or printing a reduced message.") missing from resulting documentation:

image

@llvmbot
Copy link
Member

llvmbot commented Jul 9, 2025

@llvm/pr-subscribers-llvm-support

Author: Glebs Ivanovskis (i-ky)

Changes

One line in Doxygen comment block is a regular // comment and is skipped by Doxygen leading to a phrase missing from resulting documentation:

image


Full diff: https://github.com/llvm/llvm-project/pull/147674.diff

1 Files Affected:

  • (modified) llvm/include/llvm/Support/ErrorHandling.h (+1-1)
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants