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, 11 insertions, 14 deletions

diff --git a/lldb/scripts/interface/SBSection.i b/lldb/scripts/interface/SBSection.i
index 8dc3d1564a5..4f57d7f434e 100644
--- a/lldb/scripts/interface/SBSection.i
+++ b/lldb/scripts/interface/SBSection.i
@@ -71,7 +71,7 @@ public:
 
     lldb::addr_t
     GetLoadAddress (lldb::SBTarget &target);
-    
+
     lldb::addr_t
     GetByteSize ();
 
@@ -80,7 +80,7 @@ public:
 
     uint64_t
     GetFileByteSize ();
-    
+
     lldb::SBData
     GetSectionData ();
 
@@ -95,28 +95,25 @@ public:
     GetPermissions() const;
 
     %feature("docstring", "
-    //------------------------------------------------------------------
-    /// Return the size of a target's byte represented by this section
-    /// in numbers of host bytes. Note that certain architectures have
-    /// varying minimum addressable unit (i.e. byte) size for their 
-    /// CODE or DATA buses.
-    ///
-    /// @return
-    ///     The number of host (8-bit) bytes needed to hold a target byte
-    //------------------------------------------------------------------
-    ") GetTargetByteSize;
+    Return the size of a target's byte represented by this section
+    in numbers of host bytes. Note that certain architectures have
+    varying minimum addressable unit (i.e. byte) size for their
+    CODE or DATA buses.
+
+    @return
+        The number of host (8-bit) bytes needed to hold a target byte") GetTargetByteSize;
     uint32_t
     GetTargetByteSize ();
 
     bool
     GetDescription (lldb::SBStream &description);
-    
+
     bool
     operator == (const lldb::SBSection &rhs);
 
     bool
     operator != (const lldb::SBSection &rhs);
-     
+
     %pythoncode %{
         def __iter__(self):
             '''Iterate over all subsections in a lldb.SBSection object.'''