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, 12 insertions, 22 deletions

diff --git a/lldb/scripts/interface/SBStream.i b/lldb/scripts/interface/SBStream.i
index f6562adc6dc..fa882906d0e 100644
--- a/lldb/scripts/interface/SBStream.i
+++ b/lldb/scripts/interface/SBStream.i
@@ -28,21 +28,20 @@ For example (from test/source-manager/TestSourceManager.py),
                                                      '=>', # prefix for current line
                                                      stream)
 
-        #    2    
+        #    2
         #    3    int main(int argc, char const *argv[]) {
         # => 4        printf('Hello world.\\n'); // Set break point at this line.
         #    5        return 0;
         #    6    }
         self.expect(stream.GetData(), 'Source code displayed correctly',
                     exe=False,
-            patterns = ['=> %d.*Hello world' % self.line])
-") SBStream;
+            patterns = ['=> %d.*Hello world' % self.line])") SBStream;
 class SBStream
 {
 public:
 
     SBStream ();
-    
+
     ~SBStream ();
 
     bool
@@ -51,21 +50,15 @@ public:
     explicit operator bool() const;
 
     %feature("docstring", "
-    //--------------------------------------------------------------------------
-    /// If this stream is not redirected to a file, it will maintain a local
-    /// cache for the stream data which can be accessed using this accessor.
-    //--------------------------------------------------------------------------
-    ") GetData;
+    If this stream is not redirected to a file, it will maintain a local
+    cache for the stream data which can be accessed using this accessor.") GetData;
     const char *
     GetData ();
 
     %feature("docstring", "
-    //--------------------------------------------------------------------------
-    /// If this stream is not redirected to a file, it will maintain a local
-    /// cache for the stream output whose length can be accessed using this 
-    /// accessor.
-    //--------------------------------------------------------------------------
-    ") GetSize;
+    If this stream is not redirected to a file, it will maintain a local
+    cache for the stream output whose length can be accessed using this
+    accessor.") GetSize;
     size_t
     GetSize();
 
@@ -77,7 +70,7 @@ public:
             self->Printf("%s", str);
         }
     }
-    
+
     void
     RedirectToFile (const char *path, bool append);
 
@@ -88,12 +81,9 @@ public:
     RedirectToFileDescriptor (int fd, bool transfer_fh_ownership);
 
     %feature("docstring", "
-    //--------------------------------------------------------------------------
-    /// If the stream is redirected to a file, forget about the file and if
-    /// ownership of the file was transferred to this object, close the file.
-    /// If the stream is backed by a local cache, clear this cache.
-    //--------------------------------------------------------------------------
-    ") Clear;
+    If the stream is redirected to a file, forget about the file and if
+    ownership of the file was transferred to this object, close the file.
+    If the stream is backed by a local cache, clear this cache.") Clear;
     void
     Clear ();
 };