Clean up docstrings in swig interface files

Summary:
This patch removes the "//----" frames and "///" leading lines from
docstring comments.  We already have code doing transformations like this in
modify-python-lldb.py, but that's a script I'd like to remove. Instead
of running these transformations everytime we run swig, we can just
perform equivalent on its input once.

This patch can be reproduced (e.g. for downstream merges) with the
following "sweet" perl command:

  perl -i -p -e 'BEGIN{ $/ = undef;} s:(" *\n) *//-----*\n:\1:gs; s:^(     *)/// ?:\1:gsm; s:^ *//------*\n( *\n)?( *"):\2:gsm; s: *$::gsm; s:\n *"\):"):gsm' scripts/interface/*.i

This command produces nearly equivalent python files to those produced
by the relevant code in modify-python-lldb.py. The only difference I
noticed is that here I am slightly more agressive in removing trailing
newlines from docstring comments (the python script seems to leave
newlines in class-level docstrings).

Reviewers: amccarth, clayborg, jingham, aprantl

Subscribers: lldb-commits

Differential Revision: https://reviews.llvm.org/D60498

llvm-svn: 358683

1 files changed, 4 insertions, 6 deletions

diff --git a/lldb/scripts/interface/SBQueue.i b/lldb/scripts/interface/SBQueue.i
index 0ddc1fa3eaa..f209d59f1bf 100644
--- a/lldb/scripts/interface/SBQueue.i
+++ b/lldb/scripts/interface/SBQueue.i
@@ -14,7 +14,7 @@ public:
     SBQueue ();
 
     SBQueue (const lldb::QueueSP& queue_sp);
-    
+
    ~SBQueue();
 
     bool
@@ -32,8 +32,7 @@ public:
     Returns an lldb::queue_id_t type unique identifier number for this
     queue that will not be used by any other queue during this process'
     execution.  These ID numbers often start at 1 with the first
-    system-created queues and increment from there.
-    ")
+    system-created queues and increment from there.")
     GetQueueID;
 
     lldb::queue_id_t
@@ -43,10 +42,9 @@ public:
     GetName () const;
 
     %feature("autodoc", "
-    Returns an lldb::QueueKind enumerated value (e.g. eQueueKindUnknown, 
+    Returns an lldb::QueueKind enumerated value (e.g. eQueueKindUnknown,
     eQueueKindSerial, eQueueKindConcurrent) describing the type of this
-    queue.
-    ")
+    queue.")
     GetKind();
 
     lldb::QueueKind