From de905773ae782c3526a8b2c11feb6f215f86a3eb Mon Sep 17 00:00:00 2001 From: Jason Molenda Date: Thu, 28 May 2015 04:55:53 +0000 Subject: [PATCH] Add quick bit of doc about SBFrame::GetCFA(). llvm-svn: 238395 --- lldb/scripts/interface/SBFrame.i | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lldb/scripts/interface/SBFrame.i b/lldb/scripts/interface/SBFrame.i index f1dd5cee531c..5a5bbf483a8e 100644 --- a/lldb/scripts/interface/SBFrame.i +++ b/lldb/scripts/interface/SBFrame.i @@ -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;