Add some docstrings for SBSourceManager class.

llvm-svn: 135539

1 files changed, 26 insertions, 0 deletions

diff --git a/lldb/scripts/Python/interface/SBSourceManager.i b/lldb/scripts/Python/interface/SBSourceManager.i
index d4fd87a17ba..09cd449149d 100644
--- a/lldb/scripts/Python/interface/SBSourceManager.i
+++ b/lldb/scripts/Python/interface/SBSourceManager.i
@@ -9,6 +9,32 @@
 
 namespace lldb {
 
+%feature("docstring",
+"Represents a central authority for displaying source code.
+
+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])
+") SBSourceManager;
 class SBSourceManager
 {
 public: