Add some docstrings for SBStream class.

llvm-svn: 135536

1 files changed, 47 insertions, 8 deletions

diff --git a/lldb/scripts/Python/interface/SBStream.i b/lldb/scripts/Python/interface/SBStream.i
index 56543609ac9..8a6a8e57d69 100644
--- a/lldb/scripts/Python/interface/SBStream.i
+++ b/lldb/scripts/Python/interface/SBStream.i
@@ -11,6 +11,33 @@
 
 namespace lldb {
 
+%feature("docstring",
+"Represents a destination for streaming data output to. By default, a string
+stream is created.
+
+For example (from test/source-manager/TestSourceManager.py),
+
+        # Create the filespec for 'main.c'.
+        filespec = lldb.SBFileSpec('main.c', False)
+        source_mgr = self.dbg.GetSourceManager()
+        # Use a string stream as the destination.
+        stream = lldb.SBStream()
+        source_mgr.DisplaySourceLinesWithLineNumbers(filespec,
+                                                     self.line,
+                                                     2, # context before
+                                                     2, # context after
+                                                     '=>', # prefix for current line
+                                                     stream)
+
+        #    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;
 class SBStream
 {
 public:
@@ -22,14 +49,22 @@ public:
     bool
     IsValid() const;
 
-    // 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.
+    %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;
     const char *
     GetData ();
 
-    // 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.
+    %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;
     size_t
     GetSize();
 
@@ -45,9 +80,13 @@ public:
     void
     RedirectToFileDescriptor (int fd, bool transfer_fh_ownership);
 
-    // If the stream is redirected to a file, forget about the file and if
-    // ownership of the file was transfered to this object, close the file.
-    // If the stream is backed by a local cache, clear this cache.
+    %feature("docstring", "
+    //--------------------------------------------------------------------------
+    /// If the stream is redirected to a file, forget about the file and if
+    /// ownership of the file was transfered to this object, close the file.
+    /// If the stream is backed by a local cache, clear this cache.
+    //--------------------------------------------------------------------------
+    ") Clear;
     void
     Clear ();
 };