[Lldb-commits] [lldb] r135539 - /lldb/trunk/scripts/Python/interface/SBSourceManager.i

[Johnny Chen]

Author: johnny
Date: Tue Jul 19 18:35:10 2011
New Revision: 135539

URL: http://llvm.org/viewvc/llvm-project?rev=135539&view=rev
Log:
Add some docstrings for SBSourceManager class.

Modified:
    lldb/trunk/scripts/Python/interface/SBSourceManager.i

Modified: lldb/trunk/scripts/Python/interface/SBSourceManager.i
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/Python/interface/SBSourceManager.i?rev=135539&r1=135538&r2=135539&view=diff
==============================================================================
--- lldb/trunk/scripts/Python/interface/SBSourceManager.i (original)
+++ lldb/trunk/scripts/Python/interface/SBSourceManager.i Tue Jul 19 18:35:10 2011
@@ -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: