[Lldb-commits] [PATCH] D60443: Fix doxygen warning about function argument
Konrad Kleine via Phabricator via lldb-commits
lldb-commits at lists.llvm.org
Tue Apr 9 01:43:32 PDT 2019
kkleine created this revision.
Herald added a project: LLDB.
Herald added a subscriber: lldb-commits.
kkleine added a reviewer: JDevlieghere.
This fixes the following doxygen warning when building the lldb-cpp-doc target:
This commit fixes:
llvm-project/lldb/include/lldb/API/SBStructuredData.h:94 warning: Found unknown command `\dst'
llvm-project/lldb/include/lldb/API/SBStructuredData.h:97 warning: Found unknown command `\dst'
llvm-project/lldb/include/lldb/API/SBStructuredData.h:98 warning: Found unknown command `\dst'
llvm-project/lldb/include/lldb/API/SBStructuredData.h:100 warning: Found unknown command `\dst'
llvm-project/lldb/include/lldb/API/SBStructuredData.h:104 warning: Found unknown command `\dst'
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D60443
Files:
lldb/include/lldb/API/SBStructuredData.h
Index: lldb/include/lldb/API/SBStructuredData.h
===================================================================
--- lldb/include/lldb/API/SBStructuredData.h
+++ lldb/include/lldb/API/SBStructuredData.h
@@ -91,17 +91,17 @@
///
/// \param[out] dst
/// pointer where the string value will be written. In case it is null,
- /// nothing will be written at @dst.
+ /// nothing will be written at \a dst.
///
/// \param[in] dst_len
- /// max number of characters that can be written at @dst. In case it is
- /// zero, nothing will be written at @dst. If this length is not enough
- /// to write the complete string value, (dst_len-1) bytes of the string
- /// value will be written at @dst followed by a null character.
+ /// max number of characters that can be written at \a dst. In case it is
+ /// zero, nothing will be written at \a dst. If this length is not enough
+ /// to write the complete string value, (\a dst_len - 1) bytes of the
+ /// string value will be written at \a dst followed by a null character.
///
/// \return
/// Returns the byte size needed to completely write the string value at
- /// @dst in all cases.
+ /// \a dst in all cases.
//------------------------------------------------------------------
size_t GetStringValue(char *dst, size_t dst_len) const;
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D60443.194265.patch
Type: text/x-patch
Size: 1382 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20190409/61a3ba1a/attachment-0001.bin>
More information about the lldb-commits
mailing list