[Lldb-commits] [lldb] r238395 - Add quick bit of doc about SBFrame::GetCFA().

[Jason Molenda]

Author: jmolenda
Date: Wed May 27 23:55:53 2015
New Revision: 238395

URL: http://llvm.org/viewvc/llvm-project?rev=238395&view=rev
Log:
Add quick bit of doc about SBFrame::GetCFA().

Modified:
    lldb/trunk/scripts/interface/SBFrame.i

Modified: lldb/trunk/scripts/interface/SBFrame.i
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/interface/SBFrame.i?rev=238395&r1=238394&r2=238395&view=diff
==============================================================================
--- lldb/trunk/scripts/interface/SBFrame.i (original)
+++ lldb/trunk/scripts/interface/SBFrame.i Wed May 27 23:55:53 2015
@@ -63,6 +63,12 @@ public:
     uint32_t
     GetFrameID () const;
 
+    %feature("docstring", "
+    Get the Canonical Frame Address for this stack frame.
+    This is the DWARF standard's definition of a CFA, a stack address
+    that remains constant throughout the lifetime of the function.
+    Returns an lldb::addr_t stack address, or LLDB_INVALID_ADDRESS if
+    the CFA cannot be determined.") GetCFA;
     lldb::addr_t
     GetCFA () const;