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

[felipepiovezan]

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.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Felipe de Azevedo Piovezan (felipepiovezan)

Changes

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.

---

Full diff: https://github.com/llvm/llvm-project/pull/153728.diff

1 Files Affected:

• (modified) lldb/include/lldb/Target/StackFrame.h (+6-2)

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

[jimingham]

LGTM