[lldb][nfc] Update docstring of StackFrame "get variable" methods. (#153728)
This commits makes the docs more precise, clarifying how scopes affect the result of a method, as well as documenting a parameter of a different method.
This commit is contained in:
parent
f396657bf9
commit
99e690bc75
@ -241,8 +241,9 @@ public:
|
||||
return m_reg_context_sp;
|
||||
}
|
||||
|
||||
/// Retrieve the list of variables that are in scope at this StackFrame's
|
||||
/// pc.
|
||||
/// Retrieve the list of variables whose scope either:
|
||||
/// * contains this StackFrame's pc,
|
||||
/// * is a child of this StackFrame's current scope.
|
||||
///
|
||||
/// A frame that is not live may return an empty VariableList for a given
|
||||
/// pc value even though variables would be available at this point if it
|
||||
@ -274,6 +275,9 @@ public:
|
||||
/// that are visible to the entire compilation unit (e.g. file
|
||||
/// static in C, globals that are homed in this CU).
|
||||
///
|
||||
/// \param[in] must_have_valid_location
|
||||
/// Whether to filter variables whose location is not available at this
|
||||
/// StackFrame's pc.
|
||||
/// \return
|
||||
/// A pointer to a list of variables.
|
||||
lldb::VariableListSP
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user