[Lldb-commits] [lldb] Add doc strings for SBValue::IsValid and SBValue::GetError. (PR #94007)
Alex Langford via lldb-commits
lldb-commits at lists.llvm.org
Fri May 31 13:27:17 PDT 2024
================
@@ -45,6 +45,36 @@ SBValue instance which interprets the value object as representing the head of a
linked list."
) lldb::SBValue;
+%feature("docstring", "
+Returns true if the SBValue holds any useful state
+and false otherwise.
+IsValid is a very weak API, lldb will only return
+invalid SBValues if it has no useful information
+about the SBValue.
+The two main ways you will end up with an invalid
+SBValue are:
+1) default constructed SBValues are not valid.
+2) SBValues that have outlived their SBTarget are
+no longer valid since its not safe to ask them
+questions.
+"
+) lldb::SBValue::IsValid
+
+%feature("docstring", "
+SBValues use the lldb::SBError object returned by
+this API to report construction errors when the SBValue
+is made; and on each stop, the SBError will tell you
+whether lldb could successfully determine the value for
+this program entity represented by this SBValue.
----------------
bulbazord wrote:
`this program entity` -> `the program entity`
You have "this" twice in a row, it reads a bit repetitive IMO.
https://github.com/llvm/llvm-project/pull/94007
More information about the lldb-commits
mailing list