[Lldb-commits] [lldb] r353752 - Use of `@return` is not appropriate for a function with a void return type.

Jonas Devlieghere via lldb-commits lldb-commits at lists.llvm.org
Mon Feb 11 13:43:18 PST 2019


Author: jdevlieghere
Date: Mon Feb 11 13:43:18 2019
New Revision: 353752

URL: http://llvm.org/viewvc/llvm-project?rev=353752&view=rev
Log:
Use of `@return` is not appropriate for a function with a void return type.

The comment for this declaration causes a warning with -Wdocumentation:
Invalid @return in documentation comment SetCollectingStats() in
SBTarget.h.

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

Modified: lldb/trunk/include/lldb/API/SBTarget.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/API/SBTarget.h?rev=353752&r1=353751&r2=353752&view=diff
==============================================================================
--- lldb/trunk/include/lldb/API/SBTarget.h (original)
+++ lldb/trunk/include/lldb/API/SBTarget.h Mon Feb 11 13:43:18 2019
@@ -75,8 +75,6 @@ public:
   ///
   /// @param[in] v
   ///     A boolean to control the collection.
-  /// @return
-  ///     void
   //------------------------------------------------------------------
   void SetCollectingStats(bool v);
 




More information about the lldb-commits mailing list