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/SBFrame.i b/scripts/Python/interface/SBFrame.i
index 20093a0..7d02564 100644
--- a/scripts/Python/interface/SBFrame.i
+++ b/scripts/Python/interface/SBFrame.i
@@ -272,73 +272,73 @@
__swig_getmethods__["pc"] = GetPC
__swig_setmethods__["pc"] = SetPC
- if _newclass: x = property(GetPC, SetPC)
+ if _newclass: pc = property(GetPC, SetPC)
__swig_getmethods__["addr"] = GetPCAddress
- if _newclass: x = property(GetPCAddress, None)
+ if _newclass: addr = property(GetPCAddress, None, doc='''A read only property that returns the program counter (PC) as a section offset address (lldb.SBAddress).''')
__swig_getmethods__["fp"] = GetFP
- if _newclass: x = property(GetFP, None)
+ if _newclass: fp = property(GetFP, None, doc='''A read only property that returns the frame pointer (FP) as an unsigned integer.''')
__swig_getmethods__["sp"] = GetSP
- if _newclass: x = property(GetSP, None)
+ if _newclass: sp = property(GetSP, None, doc='''A read only property that returns the stack pointer (SP) as an unsigned integer.''')
__swig_getmethods__["module"] = GetModule
- if _newclass: x = property(GetModule, None)
+ if _newclass: module = property(GetModule, None, doc='''A read only property that returns an lldb object that represents the module (lldb.SBModule) for this stack frame.''')
__swig_getmethods__["compile_unit"] = GetCompileUnit
- if _newclass: x = property(GetCompileUnit, None)
+ if _newclass: compile_unit = property(GetCompileUnit, None, doc='''A read only property that returns an lldb object that represents the compile unit (lldb.SBCompileUnit) for this stack frame.''')
__swig_getmethods__["function"] = GetFunction
- if _newclass: x = property(GetFunction, None)
+ if _newclass: function = property(GetFunction, None, doc='''A read only property that returns an lldb object that represents the function (lldb.SBFunction) for this stack frame.''')
__swig_getmethods__["symbol"] = GetSymbol
- if _newclass: x = property(GetSymbol, None)
+ if _newclass: symbol = property(GetSymbol, None, doc='''A read only property that returns an lldb object that represents the symbol (lldb.SBSymbol) for this stack frame.''')
__swig_getmethods__["block"] = GetBlock
- if _newclass: x = property(GetBlock, None)
+ if _newclass: block = property(GetBlock, None, doc='''A read only property that returns an lldb object that represents the block (lldb.SBBlock) for this stack frame.''')
__swig_getmethods__["is_inlined"] = IsInlined
- if _newclass: x = property(IsInlined, None)
+ if _newclass: is_inlined = property(IsInlined, None, doc='''A read only property that returns an boolean that indicates if the block frame is an inlined function.''')
__swig_getmethods__["name"] = GetFunctionName
- if _newclass: x = property(GetFunctionName, None)
+ if _newclass: name = property(GetFunctionName, None, doc='''A read only property that retuns the name for the function that this frame represents. Inlined stack frame might have a concrete function that differs from the name of the inlined function (a named lldb.SBBlock).''')
__swig_getmethods__["line_entry"] = GetLineEntry
- if _newclass: x = property(GetLineEntry, None)
+ if _newclass: line_entry = property(GetLineEntry, None, doc='''A read only property that returns an lldb object that represents the line table entry (lldb.SBLineEntry) for this stack frame.''')
__swig_getmethods__["thread"] = GetThread
- if _newclass: x = property(GetThread, None)
+ if _newclass: thread = property(GetThread, None, doc='''A read only property that returns an lldb object that represents the thread (lldb.SBThread) for this stack frame.''')
__swig_getmethods__["disassembly"] = Disassemble
- if _newclass: x = property(Disassemble, None)
+ if _newclass: disassembly = property(Disassemble, None, doc='''A read only property that returns the disassembly for this stack frame as a python string.''')
__swig_getmethods__["idx"] = GetFrameID
- if _newclass: x = property(GetFrameID, None)
+ if _newclass: idx = property(GetFrameID, None, doc='''A read only property that returns the zero based stack frame index.''')
__swig_getmethods__["variables"] = get_all_variables
- if _newclass: x = property(get_all_variables, None)
+ if _newclass: variables = property(get_all_variables, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the variables in this stack frame.''')
__swig_getmethods__["vars"] = get_all_variables
- if _newclass: x = property(get_all_variables, None)
+ if _newclass: vars = property(get_all_variables, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the variables in this stack frame.''')
__swig_getmethods__["locals"] = get_locals
- if _newclass: x = property(get_locals, None)
+ if _newclass: locals = property(get_locals, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the local variables in this stack frame.''')
__swig_getmethods__["args"] = get_arguments
- if _newclass: x = property(get_arguments, None)
+ if _newclass: args = property(get_arguments, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.''')
__swig_getmethods__["arguments"] = get_arguments
- if _newclass: x = property(get_arguments, None)
+ if _newclass: arguments = property(get_arguments, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.''')
__swig_getmethods__["statics"] = get_statics
- if _newclass: x = property(get_statics, None)
+ if _newclass: statics = property(get_statics, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the static variables in this stack frame.''')
__swig_getmethods__["registers"] = GetRegisters
- if _newclass: x = property(GetRegisters, None)
+ if _newclass: registers = property(GetRegisters, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.''')
__swig_getmethods__["regs"] = GetRegisters
- if _newclass: x = property(GetRegisters, None)
+ if _newclass: regs = property(GetRegisters, None, doc='''A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.''')
%}
};