================
@@ -10,21 +10,45 @@
#define LLDB_SOURCE_PLUGINS_SCRIPTED_FRAME_H
#include "ScriptedThread.h"
-#include "lldb/Interpreter/ScriptInterpreter.h"
#include "lldb/Target/DynamicRegisterInfo.h"
#include "lldb/Target/StackFrame.h"
+#include "lldb/lldb-forward.h"
+#include "llvm/Support/Error.h"
+#include <memory>
#include <string>
-namespace lldb_private {
-class ScriptedThread;
-}
-
namespace lldb_private {
class ScriptedFrame : public lldb_private::StackFrame {
public:
- ScriptedFrame(ScriptedThread &thread,
+ /// Construct a ScriptedFrame.
+ ///
+ /// \param[in] thread_sp
+ /// The thread this frame belongs to.
+ ///
+ /// \param[in] interface_sp
+ /// The scripted frame interface for interacting with the script object.
+ ///
+ /// \param[in] frame_idx
+ /// The frame index in the stack frame list.
+ ///
+ /// \param[in] pc
+ /// The program counter address for this frame.
+ ///
+ /// \param[in] sym_ctx
+ /// The symbol context for this frame.
+ ///
+ /// \param[in] reg_ctx_sp
+ /// The register context for this frame.
+ ///
+ /// \param[in] reg_info_sp
+ /// The dynamic register information for this frame.
+ ///
+ /// \param[in] script_object_sp
+ /// The optional script object representing this frame in the scripting
+ /// language.
----------------
JDevlieghere wrote:
These params are hardly adding anything and they almost always inevitably end
up getting out of date. I'd be less concerned if we were `-Wdocumentation`
clean in `lldb_private` and have the warning enabled. Personally, I would just
remove all of this.
https://github.com/llvm/llvm-project/pull/161870
_______________________________________________
lldb-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
