[Lldb-commits] [lldb] r358055 - Docstringify some comments in the swig interface files

[Pavel Labath via lldb-commits]

Author: labath
Date: Wed Apr 10 00:55:04 2019
New Revision: 358055

URL: http://llvm.org/viewvc/llvm-project?rev=358055&view=rev
Log:
Docstringify some comments in the swig interface files

Without these, the comments don't end up in the generated python code.

Modified:
    lldb/trunk/scripts/interface/SBModuleSpec.i
    lldb/trunk/scripts/interface/SBProcess.i
    lldb/trunk/scripts/interface/SBThreadPlan.i

Modified: lldb/trunk/scripts/interface/SBModuleSpec.i
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/interface/SBModuleSpec.i?rev=358055&r1=358054&r2=358055&view=diff
==============================================================================
--- lldb/trunk/scripts/interface/SBModuleSpec.i (original)
+++ lldb/trunk/scripts/interface/SBModuleSpec.i Wed Apr 10 00:55:04 2019
@@ -26,6 +26,7 @@ public:
     void
     Clear();
     
+    %feature("docstring", "
     //------------------------------------------------------------------
     /// Get const accessor for the module file.
     ///
@@ -36,12 +37,14 @@ public:
     /// @return
     ///     A const reference to the file specification object.
     //------------------------------------------------------------------
+    ") GetFileSpec;
     lldb::SBFileSpec
     GetFileSpec ();
     
     void
     SetFileSpec (const lldb::SBFileSpec &fspec);
     
+    %feature("docstring", "
     //------------------------------------------------------------------
     /// Get accessor for the module platform file.
     ///
@@ -57,6 +60,7 @@ public:
     /// @return
     ///     A const reference to the file specification object.
     //------------------------------------------------------------------
+    ") GetPlatformFileSpec;
     lldb::SBFileSpec
     GetPlatformFileSpec ();
     

Modified: lldb/trunk/scripts/interface/SBProcess.i
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/interface/SBProcess.i?rev=358055&r1=358054&r2=358055&view=diff
==============================================================================
--- lldb/trunk/scripts/interface/SBProcess.i (original)
+++ lldb/trunk/scripts/interface/SBProcess.i Wed Apr 10 00:55:04 2019
@@ -34,9 +34,6 @@ def get_stopped_threads(process, reason)
 class SBProcess
 {
 public:
-    //------------------------------------------------------------------
-    /// Broadcaster event bits definitions.
-    //------------------------------------------------------------------
     enum
     {
         eBroadcastBitStateChanged   = (1 << 0),

Modified: lldb/trunk/scripts/interface/SBThreadPlan.i
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/interface/SBThreadPlan.i?rev=358055&r1=358054&r2=358055&view=diff
==============================================================================
--- lldb/trunk/scripts/interface/SBThreadPlan.i (original)
+++ lldb/trunk/scripts/interface/SBThreadPlan.i Wed Apr 10 00:55:04 2019
@@ -48,11 +48,14 @@ public:
     lldb::StopReason
     GetStopReason();
 
+    %feature("docstring", "
     /// Get the number of words associated with the stop reason.
     /// See also GetStopReasonDataAtIndex().
+    ") GetStopReasonDataCount;
     size_t
     GetStopReasonDataCount();
 
+    %feature("docstring", "
     //--------------------------------------------------------------------------
     /// Get information associated with a stop reason.
     ///
@@ -71,6 +74,7 @@ public:
     /// eStopReasonExec          0
     /// eStopReasonPlanComplete  0
     //--------------------------------------------------------------------------
+    ") GetStopReasonDataAtIndex;
     uint64_t
     GetStopReasonDataAtIndex(uint32_t idx);
 
@@ -94,7 +98,6 @@ public:
 
     explicit operator bool() const;
 
-    // This section allows an SBThreadPlan to push another of the common types of plans...
     SBThreadPlan
     QueueThreadPlanForStepOverRange (SBAddress &start_address,
                                      lldb::addr_t range_size);