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, 11 insertions, 11 deletions

diff --git a/lldb/scripts/Python/interface/SBThread.i b/lldb/scripts/Python/interface/SBThread.i
index 295a775f060..ac6e699fcc6 100644
--- a/lldb/scripts/Python/interface/SBThread.i
+++ b/lldb/scripts/Python/interface/SBThread.i
@@ -202,37 +202,37 @@ public:
             return frames
         
         __swig_getmethods__["id"] = GetThreadID
-        if _newclass: x = property(GetThreadID, None)
+        if _newclass: id = property(GetThreadID, None, doc='''A read only property that returns the thread ID as an integer.''')
 
         __swig_getmethods__["idx"] = GetIndexID
-        if _newclass: x = property(GetIndexID, None)
+        if _newclass: idx = property(GetIndexID, None, doc='''A read only property that returns the thread index ID as an integer. Thread index ID values start at 1 and increment as threads come and go and can be used to uniquely identify threads.''')
 
         __swig_getmethods__["return_value"] = GetStopReturnValue
-        if _newclass: x = property(GetStopReturnValue, None)
+        if _newclass: return_value = property(GetStopReturnValue, None, doc='''A read only property that returns an lldb object that represents the return value from the last stop (lldb.SBValue) if we just stopped due to stepping out of a function.''')
 
         __swig_getmethods__["process"] = GetProcess
-        if _newclass: x = property(GetProcess, None)
+        if _newclass: process = property(GetProcess, None, doc='''A read only property that returns an lldb object that represents the process (lldb.SBProcess) that owns this thread.''')
 
         __swig_getmethods__["num_frames"] = GetNumFrames
-        if _newclass: x = property(GetNumFrames, None)
+        if _newclass: num_frames = property(GetNumFrames, None, doc='''A read only property that returns the number of stack frames in this thread as an integer.''')
 
         __swig_getmethods__["frames"] = get_thread_frames
-        if _newclass: x = property(get_thread_frames, None)
+        if _newclass: frames = property(get_thread_frames, None, doc='''A read only property that returns a list() of lldb.SBFrame objects for all frames in this thread.''')
 
         __swig_getmethods__["frame"] = get_frames_access_object
-        if _newclass: x = property(get_frames_access_object, None)
+        if _newclass: frame = property(get_frames_access_object, None, doc='''A read only property that returns an object that can be used to access frames as an array ("frame_12 = lldb.thread.frame[12]").''')
 
         __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 of this thread as a string.''')
 
         __swig_getmethods__["queue"] = GetQueueName
-        if _newclass: x = property(GetQueueName, None)
+        if _newclass: queue = property(GetQueueName, None, doc='''A read only property that returns the dispatch queue name of this thread as a string.''')
 
         __swig_getmethods__["stop_reason"] = GetStopReason
-        if _newclass: x = property(GetStopReason, None)
+        if _newclass: stop_reason = property(GetStopReason, None, doc='''A read only property that returns an lldb enumeration value (see enumerations that start with "lldb.eStopReason") that represents the reason this thread stopped.''')
 
         __swig_getmethods__["is_suspended"] = IsSuspended
-        if _newclass: x = property(IsSuspended, None)
+        if _newclass: is_suspended = property(IsSuspended, None, doc='''A read only property that returns a boolean value that indicates if this thread is suspended.''')
     %}
 
 };