[Lldb-commits] [lldb] r357983 - Fix doxygen warning about function argument

[Jonas Devlieghere via lldb-commits]

Author: jdevlieghere
Date: Tue Apr  9 02:03:30 2019
New Revision: 357983

URL: http://llvm.org/viewvc/llvm-project?rev=357983&view=rev
Log:
Fix doxygen warning about function argument

This fixes the following doxygen warning when building the lldb-cpp-doc
target.

This commit fixes:
  SBStructuredData.h:94 warning: Found unknown command `\dst'
  SBStructuredData.h:97 warning: Found unknown command `\dst'
  SBStructuredData.h:98 warning: Found unknown command `\dst'
  SBStructuredData.h:100 warning: Found unknown command `\dst'
  SBStructuredData.h:104 warning: Found unknown command `\dst'

Patch by: Konrad Kleine

Differential revision: https://reviews.llvm.org/D60443

Modified:
    lldb/trunk/include/lldb/API/SBStructuredData.h

Modified: lldb/trunk/include/lldb/API/SBStructuredData.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/API/SBStructuredData.h?rev=357983&r1=357982&r2=357983&view=diff
==============================================================================
--- lldb/trunk/include/lldb/API/SBStructuredData.h (original)
+++ lldb/trunk/include/lldb/API/SBStructuredData.h Tue Apr  9 02:03:30 2019
@@ -91,17 +91,17 @@ public:
   ///
   /// \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;