https://github.com/felipepiovezan created
https://github.com/llvm/llvm-project/pull/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.
>From 4aa57dc057c8f2b8a1d6cff17537281a3a4b900a Mon Sep 17 00:00:00 2001
From: Felipe de Azevedo Piovezan <fpiove...@apple.com>
Date: Thu, 14 Aug 2025 18:54:44 -0700
Subject: [PATCH] [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.
---
lldb/include/lldb/Target/StackFrame.h | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/lldb/include/lldb/Target/StackFrame.h
b/lldb/include/lldb/Target/StackFrame.h
index 3f51c9a7f22f0..d4104bfe49d20 100644
--- a/lldb/include/lldb/Target/StackFrame.h
+++ b/lldb/include/lldb/Target/StackFrame.h
@@ -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
@@ -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
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
