Skip to content

[lldb][nfc] Update docstring of StackFrame "get variable" methods. #153728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 15, 2025
+6 −2
Merged

[lldb][nfc] Update docstring of StackFrame "get variable" methods. #153728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions lldb/include/lldb/Target/StackFrame.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,9 @@ class StackFrame : public ExecutionContextScope,
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
Expand Down Expand Up @@ -274,6 +275,9 @@ class StackFrame : public ExecutionContextScope,
/// 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
Expand Down
Loading