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.

llvm-svn: 159468

1 files changed, 26 insertions, 26 deletions

diff --git a/lldb/scripts/Python/interface/SBValue.i b/lldb/scripts/Python/interface/SBValue.i
index 4b9d5d727b4..c00276b76ab 100644
--- a/lldb/scripts/Python/interface/SBValue.i
+++ b/lldb/scripts/Python/interface/SBValue.i
@@ -387,81 +387,81 @@ public:
             return self.GetDynamicValue (eDynamicCanRunTarget)
         
         __swig_getmethods__["name"] = GetName
-        if _newclass: name = property(GetName, None, doc='Returns the name of this SBValue as a string')
+        if _newclass: name = property(GetName, None, doc='''A read only property that returns the name of this value as a string.''')
 
         __swig_getmethods__["type"] = GetType
-        if _newclass: type = property(GetType, None, doc='Returns an SBType that represents the type of this SBValue')
+        if _newclass: type = property(GetType, None, doc='''A read only property that returns a lldb.SBType object that represents the type for this value.''')
 
         __swig_getmethods__["size"] = GetByteSize
-        if _newclass: size = property(GetByteSize, None, doc='Returns the size (in bytes) of the data contained in this SBValue')
+        if _newclass: size = property(GetByteSize, None, doc='''A read only property that returns the size in bytes of this value.''')
 
         __swig_getmethods__["is_in_scope"] = IsInScope
-        if _newclass: is_in_scope = property(IsInScope, None, doc='Returns True if this SBValue represents an item that is currently in lexical scope')
+        if _newclass: is_in_scope = property(IsInScope, None, doc='''A read only property that returns a boolean value that indicates whether this value is currently lexically in scope.''')
 
         __swig_getmethods__["format"] = GetFormat
         __swig_setmethods__["format"] = SetFormat
-        if _newclass: format = property(GetName, SetFormat, doc='Returns the format for this SBValue')
+        if _newclass: format = property(GetName, SetFormat, doc='''A read/write property that gets/sets the format used for lldb.SBValue().GetValue() for this value. See enumerations that start with "lldb.eFormat".''')
 
         __swig_getmethods__["value"] = GetValue
         __swig_setmethods__["value"] = SetValueFromCString
-        if _newclass: value = property(GetValue, SetValueFromCString, doc='Returns the value of this SBValue as a string')
+        if _newclass: value = property(GetValue, SetValueFromCString, doc='''A read/write property that gets/sets value from a string.''')
 
         __swig_getmethods__["value_type"] = GetValueType
-        if _newclass: value_type = property(GetValueType, None, doc='Returns the type of entry stored in this SBValue')
+        if _newclass: value_type = property(GetValueType, None, doc='''A read only property that returns an lldb enumeration value (see enumerations that start with "lldb.eValueType") that represents the type of this value (local, argument, global, register, etc.).''')
 
         __swig_getmethods__["changed"] = GetValueDidChange
-        if _newclass: changed = property(GetValueDidChange, None, doc='Returns True if this SBValue represents an item that has changed')
+        if _newclass: changed = property(GetValueDidChange, None, doc='''A read only property that returns a boolean value that indicates if this value has changed since it was last updated.''')
 
         __swig_getmethods__["data"] = GetData
-        if _newclass: data = property(GetData, None, doc='Returns an SBData wrapping the contents of this SBValue')
+        if _newclass: data = property(GetData, None, doc='''A read only property that returns an lldb object (lldb.SBData) that represents the bytes that make up the value for this object.''')
 
         __swig_getmethods__["load_addr"] = GetLoadAddress
-        if _newclass: load_addr = property(GetLoadAddress, None, doc='Returns the load address (target address) of this SBValue as a number')
+        if _newclass: load_addr = property(GetLoadAddress, None, doc='''A read only property that returns the load address of this value as an integer.''')
 
         __swig_getmethods__["addr"] = GetAddress
-        if _newclass: addr = property(GetAddress, None, doc='Returns the address of this SBValue as an SBAddress')
+        if _newclass: addr = property(GetAddress, None, doc='''A read only property that returns an lldb.SBAddress that represents the address of this value if it is in memory.''')
 
         __swig_getmethods__["deref"] = Dereference
-        if _newclass: deref = property(Dereference, None, doc='Returns an SBValue that is created by dereferencing this SBValue')
+        if _newclass: deref = property(Dereference, None, doc='''A read only property that returns an lldb.SBValue that is created by dereferencing this value.''')
 
         __swig_getmethods__["address_of"] = AddressOf
-        if _newclass: address_of = property(AddressOf, None, doc='Returns an SBValue that wraps the address-of this SBValue')
+        if _newclass: address_of = property(AddressOf, None, doc='''A read only property that returns an lldb.SBValue that represents the address-of this value.''')
 
         __swig_getmethods__["error"] = GetError
-        if _newclass: error = property(GetError, None, doc='Returns the SBError currently associated to this SBValue')
+        if _newclass: error = property(GetError, None, doc='''A read only property that returns the lldb.SBError that represents the error from the last time the variable value was calculated.''')
     
         __swig_getmethods__["summary"] = GetSummary
-        if _newclass: summary = property(GetSummary, None, doc='Returns the summary for this SBValue as a string')
+        if _newclass: summary = property(GetSummary, None, doc='''A read only property that returns the summary for this value as a string''')
 
         __swig_getmethods__["description"] = GetObjectDescription
-        if _newclass: description = property(GetObjectDescription, None, doc='Returns the language-specific description of this SBValue as a string')
+        if _newclass: description = property(GetObjectDescription, None, doc='''A read only property that returns the language-specific description of this value as a string''')
         
         __swig_getmethods__["dynamic"] = __get_dynamic__
-        if _newclass: description = property(__get_dynamic__, None, doc='Gets the dynamic type for a value')
+        if _newclass: dynamic = property(__get_dynamic__, None, doc='''A read only property that returns an lldb.SBValue that is created by finding the dynamic type of this value.''')
         
         __swig_getmethods__["location"] = GetLocation
-        if _newclass: location = property(GetLocation, None, doc='Returns the location of this SBValue as a string')
+        if _newclass: location = property(GetLocation, None, doc='''A read only property that returns the location of this value as a string.''')
 
         __swig_getmethods__["target"] = GetTarget
-        if _newclass: target = property(GetTarget, None, doc='Returns an SBTarget for the target from which this SBValue comes')
+        if _newclass: target = property(GetTarget, None, doc='''A read only property that returns the lldb.SBTarget that this value is associated with.''')
 
         __swig_getmethods__["process"] = GetProcess
-        if _newclass: process = property(GetProcess, None, doc='Returns an SBProcess for the process from which this SBValue comes')
+        if _newclass: process = property(GetProcess, None, doc='''A read only property that returns the lldb.SBProcess that this value is associated with, the returned value might be invalid and should be tested.''')
 
         __swig_getmethods__["thread"] = GetThread
-        if _newclass: thread = property(GetThread, None, doc='Returns an SBThread for the thread from which this SBValue comes')
+        if _newclass: thread = property(GetThread, None, doc='''A read only property that returns the lldb.SBThread that this value is associated with, the returned value might be invalid and should be tested.''')
 
         __swig_getmethods__["frame"] = GetFrame
-        if _newclass: frame = property(GetFrame, None, doc='Returns an SBFrame for the stack frame from which this SBValue comes')
+        if _newclass: frame = property(GetFrame, None, doc='''A read only property that returns the lldb.SBFrame that this value is associated with, the returned value might be invalid and should be tested.''')
 
         __swig_getmethods__["num_children"] = GetNumChildren
-        if _newclass: num_children = property(GetNumChildren, None, doc='Returns the number of child SBValues that this SBValue has')
+        if _newclass: num_children = property(GetNumChildren, None, doc='''A read only property that returns the number of child lldb.SBValues that this value has.''')
 
         __swig_getmethods__["unsigned"] = GetValueAsUnsigned
-        if _newclass: unsigned = property(GetValueAsUnsigned, None, doc='Returns the value of this SBValue as an unsigned number')
+        if _newclass: unsigned = property(GetValueAsUnsigned, None, doc='''A read only property that returns the value of this SBValue as an usigned integer.''')
 
         __swig_getmethods__["signed"] = GetValueAsSigned
-        if _newclass: signed = property(GetValueAsSigned, None, doc='Returns the value of this SBValue as a signed number')
+        if _newclass: signed = property(GetValueAsSigned, None, doc='''A read only property that returns the value of this SBValue as a signed integer.''')
 
         def get_expr_path(self):
             s = SBStream()
@@ -469,7 +469,7 @@ public:
             return s.GetData()
         
         __swig_getmethods__["path"] = get_expr_path
-        if _newclass: path = property(get_expr_path, None, doc='Returns the expression path that one can use to reach this SBValue')
+        if _newclass: path = property(get_expr_path, None, doc='''A read only property that returns the expression path that one can use to reach this value in an expression.''')
     %}
 
 };