https://github.com/zfogg created 
https://github.com/llvm/llvm-project/pull/170394

## Summary
- Remove errant `\a` command before `<directory>` in `SaveToDisk` documentation
- The `\a` Doxygen command expects a word argument, but `<directory>` starts 
with `<` which Doxygen interprets as HTML
- This fixes: `Warning 564: Error parsing Doxygen command a: No word followed 
the command`

## Test plan
- Build LLDB with Doxygen enabled and verify warning no longer appears

>From fe0fc2182981d5e511e38fb86dc977c692db69a2 Mon Sep 17 00:00:00 2001
From: Zachary Fogg <[email protected]>
Date: Tue, 2 Dec 2025 19:12:08 -0500
Subject: [PATCH] [lldb] Fix Doxygen warning in SBTrace.h

   Remove errant \a command before <directory> in SaveToDisk documentation.
---
 lldb/include/lldb/API/SBTrace.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lldb/include/lldb/API/SBTrace.h b/lldb/include/lldb/API/SBTrace.h
index ce95595a423c9..d5368b234dd34 100644
--- a/lldb/include/lldb/API/SBTrace.h
+++ b/lldb/include/lldb/API/SBTrace.h
@@ -39,7 +39,7 @@ class LLDB_API SBTrace {
   SBTraceCursor CreateNewCursor(SBError &error, SBThread &thread);
 
   /// Save the trace to the specified directory, which will be created if
-  /// needed. This will also create a file \a <directory>/trace.json with the
+  /// needed. This will also create a file <directory>/trace.json with the
   /// main properties of the trace session, along with others files which
   /// contain the actual trace data. The trace.json file can be used later as
   /// input for the "trace load" command to load the trace in LLDB, or for the

_______________________________________________
lldb-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits

Reply via email to