[lldb] Fix Doxygen warning in SBTrace.h

[zfogg]

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: /home/zfogg/src/github.com/llvm/llvm-project/lldb/include/lldb/API/SBTrace.h:60: Warning 564: Error parsing Doxygen command a: No word followed the command. Command ignored.

Test plan

• Build LLDB with Doxygen enabled and verify warning no longer appears

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Zachary Fogg (zfogg)

Changes

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

---

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

1 Files Affected:

• (modified) lldb/include/lldb/API/SBTrace.h (+1-1)

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

[zfogg]

thanks @JDevlieghere .. merge when ready, all checks pass :)

[github-actions]

@zfogg Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!