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
diff --git a/scripts/Python/interface/SBSymbol.i b/scripts/Python/interface/SBSymbol.i
index 4995c4f..a365697 100644
--- a/scripts/Python/interface/SBSymbol.i
+++ b/scripts/Python/interface/SBSymbol.i
@@ -64,31 +64,31 @@
return self.GetInstructions (target)
__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 symbol as a string.''')
__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 symbol as a string.''')
__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 enumeration value (see enumerations that start with "lldb.eSymbolType") that represents the type of this symbol.''')
__swig_getmethods__["addr"] = GetStartAddress
- if _newclass: x = property(GetStartAddress, 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 symbol.''')
__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 symbol.''')
__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__["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 symbol.''')
__swig_getmethods__["external"] = IsExternal
- if _newclass: x = property(IsExternal, None)
+ if _newclass: external = property(IsExternal, None, doc='''A read only property that returns a boolean value that indicates if this symbol is externally visiable (exported) from the module that contains it.''')
__swig_getmethods__["synthetic"] = IsSynthetic
- if _newclass: x = property(IsSynthetic, None)
+ if _newclass: synthetic = property(IsSynthetic, None, doc='''A read only property that returns a boolean value that indicates if this symbol was synthetically created from information in module that contains it.''')
%}