[Lldb-commits] [lldb] r135647 - /lldb/trunk/scripts/Python/interface/SBInstructionList.i

[Johnny Chen]

Author: johnny
Date: Wed Jul 20 19:48:02 2011
New Revision: 135647

URL: http://llvm.org/viewvc/llvm-project?rev=135647&view=rev
Log:
Add docstring for SBInstructionList class.

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

Modified: lldb/trunk/scripts/Python/interface/SBInstructionList.i
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/Python/interface/SBInstructionList.i?rev=135647&r1=135646&r2=135647&view=diff
==============================================================================
--- lldb/trunk/scripts/Python/interface/SBInstructionList.i (original)
+++ lldb/trunk/scripts/Python/interface/SBInstructionList.i Wed Jul 20 19:48:02 2011
@@ -11,6 +11,20 @@
 
 namespace lldb {
 
+%feature("docstring",
+"Represents a list of machine instructions.  SBFunction and SBSymbol have
+GetInstructions() methods which return SBInstructionList instances.
+
+SBInstructionList supports instruction (SBInstruction instance) iteration.
+For example (see also SBDebugger for a more complete example),
+
+def disassemble_instructions (insts):
+    for i in insts:
+        print i
+
+defines a method which takes an SBInstructionList instance and prints out
+the machine instructions in assembly format."
+) SBInstructionList;
 class SBInstructionList
 {
 public: