Skip to content

Commit 0c71b6a

Browse files
zfoggkcloudy0717
authored andcommitted
[lldb] Fix Doxygen warning in SBTrace.h (llvm#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. ```
1 parent 8a51454 commit 0c71b6a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

lldb/include/lldb/API/SBTrace.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class LLDB_API SBTrace {
3939
SBTraceCursor CreateNewCursor(SBError &error, SBThread &thread);
4040

4141
/// Save the trace to the specified directory, which will be created if
42-
/// needed. This will also create a file \a <directory>/trace.json with the
42+
/// needed. This will also create a file <directory>/trace.json with the
4343
/// main properties of the trace session, along with others files which
4444
/// contain the actual trace data. The trace.json file can be used later as
4545
/// input for the "trace load" command to load the trace in LLDB, or for the

0 commit comments

Comments
 (0)