Skip to content

Commit 4aa57dc

Browse files
[lldb][nfc] Update docstring of StackFrame "get variable" methods.
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.
1 parent b989c7c commit 4aa57dc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

lldb/include/lldb/Target/StackFrame.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,9 @@ class StackFrame : public ExecutionContextScope,
241241
return m_reg_context_sp;
242242
}
243243

244-
/// Retrieve the list of variables that are in scope at this StackFrame's
245-
/// pc.
244+
/// Retrieve the list of variables whose scope either:
245+
/// * contains this StackFrame's pc,
246+
/// * is a child of this StackFrame's current scope.
246247
///
247248
/// A frame that is not live may return an empty VariableList for a given
248249
/// pc value even though variables would be available at this point if it
@@ -274,6 +275,9 @@ class StackFrame : public ExecutionContextScope,
274275
/// that are visible to the entire compilation unit (e.g. file
275276
/// static in C, globals that are homed in this CU).
276277
///
278+
/// \param[in] must_have_valid_location
279+
/// Whether to filter variables whose location is not available at this
280+
/// StackFrame's pc.
277281
/// \return
278282
/// A pointer to a list of variables.
279283
lldb::VariableListSP

0 commit comments

Comments
 (0)