[Lldb-commits] [lldb] 325a082 - [lldb] Fix Doxygen warning in SBTrace.h (#170394)
via lldb-commits
lldb-commits at lists.llvm.org
Tue Dec 2 16:36:05 PST 2025
Author: Zachary Fogg
Date: 2025-12-02T16:36:01-08:00
New Revision: 325a08267de9362a9b17a8fc80fdc59568fd30f8
URL: https://github.com/llvm/llvm-project/commit/325a08267de9362a9b17a8fc80fdc59568fd30f8
DIFF: https://github.com/llvm/llvm-project/commit/325a08267de9362a9b17a8fc80fdc59568fd30f8.diff
LOG: [lldb] Fix Doxygen warning in SBTrace.h (#170394)
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:
```
llvm-project/lldb/include/lldb/API/SBTrace.h:60:
Warning 564: Error parsing Doxygen command a: No word followed the command. Command ignored.
```
Added:
Modified:
lldb/include/lldb/API/SBTrace.h
Removed:
################################################################################
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
More information about the lldb-commits
mailing list