commit 2a94be1aa46c90d6749d8c96ed396d5ebde452cd
author Greg Clayton <gclayton@apple.com> Fri Jun 29 22:00:42 2012 +0000
committer Greg Clayton <gclayton@apple.com> Fri Jun 29 22:00:42 2012 +0000
tree 10d0d6e72542d2db68719c283d97d059f7a41855
parent d8746660cdb10ecf2402b5c36b82c2f6678b62ee

Added documentation for many of our python properties and also made the property help show up by declaring the properties correctly. We previosly declared properties into a local "x" variable, what I didn't realize is that the help will use this as the property name for the help output.


git-svn-id: https://llvm.org/svn/llvm-project/lldb/trunk@159468 91177308-0d34-0410-b5e6-96231b3b80d8

scripts/Python/interface/SBFunction.i

diff --git a/scripts/Python/interface/SBFunction.i b/scripts/Python/interface/SBFunction.i
index e259490..8eee92f 100644
--- a/scripts/Python/interface/SBFunction.i
+++ b/scripts/Python/interface/SBFunction.i
@@ -88,28 +88,28 @@
             return self.GetInstructions (target)
 
         __swig_getmethods__["addr"] = GetStartAddress
-        if _newclass: x = property(GetStartAddress, None)
-
-        __swig_getmethods__["block"] = GetBlock
-        if _newclass: x = property(GetBlock, None)
+        if _newclass: addr = property(GetStartAddress, None, doc='''A read only property that returns an lldb object that represents the start address (lldb.SBAddress) for this function.''')
 
         __swig_getmethods__["end_addr"] = GetEndAddress
-        if _newclass: x = property(GetEndAddress, None)
-        
+        if _newclass: end_addr = property(GetEndAddress, None, doc='''A read only property that returns an lldb object that represents the end address (lldb.SBAddress) for this function.''')
+                
+        __swig_getmethods__["block"] = GetBlock
+        if _newclass: block = property(GetBlock, None, doc='''A read only property that returns an lldb object that represents the top level lexical block (lldb.SBBlock) for this function.''')
+
         __swig_getmethods__["instructions"] = get_instructions_from_current_target
-        if _newclass: x = property(get_instructions_from_current_target, None)
+        if _newclass: instructions = property(get_instructions_from_current_target, None, doc='''A read only property that returns an lldb object that represents the instructions (lldb.SBInstructionList) for this function.''')
 
         __swig_getmethods__["mangled"] = GetMangledName
-        if _newclass: x = property(GetMangledName, None)
+        if _newclass: mangled = property(GetMangledName, None, doc='''A read only property that returns the mangled (linkage) name for this function as a string.''')
 
         __swig_getmethods__["name"] = GetName
-        if _newclass: x = property(GetName, None)
+        if _newclass: name = property(GetName, None, doc='''A read only property that returns the name for this function as a string.''')
 
         __swig_getmethods__["prologue_size"] = GetPrologueByteSize
-        if _newclass: x = property(GetPrologueByteSize, None)
+        if _newclass: prologue_size = property(GetPrologueByteSize, None, doc='''A read only property that returns the size in bytes of the prologue instructions as an unsigned integer.''')
 
         __swig_getmethods__["type"] = GetType
-        if _newclass: x = property(GetType, None)
+        if _newclass: type = property(GetType, None, doc='''A read only property that returns an lldb object that represents the return type (lldb.SBType) for this function.''')
     %}
 
 };