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, 50 insertions, 56 deletions

diff --git a/lldb/scripts/interface/SBModuleSpec.i b/lldb/scripts/interface/SBModuleSpec.i
index 87596b5683b..ec4e9bb7fbf 100644
--- a/lldb/scripts/interface/SBModuleSpec.i
+++ b/lldb/scripts/interface/SBModuleSpec.i
@@ -11,92 +11,86 @@ namespace lldb {
 class SBModuleSpec
 {
 public:
-    
+
     SBModuleSpec ();
-    
+
     SBModuleSpec (const lldb::SBModuleSpec &rhs);
-    
+
     ~SBModuleSpec ();
-    
+
     bool
     IsValid () const;
 
     explicit operator bool() const;
-    
+
     void
     Clear();
-    
+
     %feature("docstring", "
-    //------------------------------------------------------------------
-    /// Get const accessor for the module file.
-    ///
-    /// This function returns the file for the module on the host system
-    /// that is running LLDB. This can differ from the path on the
-    /// platform since we might be doing remote debugging.
-    ///
-    /// @return
-    ///     A const reference to the file specification object.
-    //------------------------------------------------------------------
-    ") GetFileSpec;
+    Get const accessor for the module file.
+
+    This function returns the file for the module on the host system
+    that is running LLDB. This can differ from the path on the
+    platform since we might be doing remote debugging.
+
+    @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.
-    ///
-    /// Platform file refers to the path of the module as it is known on
-    /// the remote system on which it is being debugged. For local
-    /// debugging this is always the same as Module::GetFileSpec(). But
-    /// remote debugging might mention a file '/usr/lib/liba.dylib'
-    /// which might be locally downloaded and cached. In this case the
-    /// platform file could be something like:
-    /// '/tmp/lldb/platform-cache/remote.host.computer/usr/lib/liba.dylib'
-    /// The file could also be cached in a local developer kit directory.
-    ///
-    /// @return
-    ///     A const reference to the file specification object.
-    //------------------------------------------------------------------
-    ") GetPlatformFileSpec;
+    Get accessor for the module platform file.
+
+    Platform file refers to the path of the module as it is known on
+    the remote system on which it is being debugged. For local
+    debugging this is always the same as Module::GetFileSpec(). But
+    remote debugging might mention a file '/usr/lib/liba.dylib'
+    which might be locally downloaded and cached. In this case the
+    platform file could be something like:
+    '/tmp/lldb/platform-cache/remote.host.computer/usr/lib/liba.dylib'
+    The file could also be cached in a local developer kit directory.
+
+    @return
+        A const reference to the file specification object.") GetPlatformFileSpec;
     lldb::SBFileSpec
     GetPlatformFileSpec ();
-    
+
     void
     SetPlatformFileSpec (const lldb::SBFileSpec &fspec);
-    
+
     lldb::SBFileSpec
     GetSymbolFileSpec ();
-    
+
     void
     SetSymbolFileSpec (const lldb::SBFileSpec &fspec);
-    
+
     const char *
     GetObjectName ();
-    
+
     void
     SetObjectName (const char *name);
-    
+
     const char *
     GetTriple ();
-    
+
     void
     SetTriple (const char *triple);
-    
+
     const uint8_t *
     GetUUIDBytes ();
-    
+
     size_t
     GetUUIDLength ();
-    
+
     bool
     SetUUIDBytes (const uint8_t *uuid, size_t uuid_len);
-    
+
     bool
     GetDescription (lldb::SBStream &description);
-    
+
 };
 
 
@@ -104,32 +98,32 @@ class SBModuleSpecList
 {
 public:
     SBModuleSpecList();
-    
+
     SBModuleSpecList (const SBModuleSpecList &rhs);
-    
+
     ~SBModuleSpecList();
-    
+
     static SBModuleSpecList
     GetModuleSpecifications (const char *path);
-    
+
     void
     Append (const lldb::SBModuleSpec &spec);
-    
+
     void
     Append (const lldb::SBModuleSpecList &spec_list);
 
     lldb::SBModuleSpec
     FindFirstMatchingSpec (const lldb::SBModuleSpec &match_spec);
-    
+
     lldb::SBModuleSpecList
     FindMatchingSpecs (const lldb::SBModuleSpec &match_spec);
-    
+
     size_t
     GetSize();
-    
+
     lldb::SBModuleSpec
     GetSpecAtIndex (size_t i);
-    
+
     bool
     GetDescription (lldb::SBStream &description);