From a48098479269cdace4d9ce32264a73eef76994dc Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Wed, 19 Nov 2025 09:20:51 +0100 Subject: feat: new documented codebase and improvements. Signed-off-by: Amlal El Mahrouss --- dev/DebuggerKit/DebuggerContract.h | 6 ++++++ dev/DebuggerKit/NeKernelContract.h | 4 ++++ dev/DebuggerKit/POSIXMachContract.h | 4 +++- dev/DebuggerKit/Platform.h | 2 ++ dev/DebuggerKit/Version.h | 2 +- 5 files changed, 16 insertions(+), 2 deletions(-) (limited to 'dev/DebuggerKit') diff --git a/dev/DebuggerKit/DebuggerContract.h b/dev/DebuggerKit/DebuggerContract.h index 9ee17d1..d1c8ed1 100644 --- a/dev/DebuggerKit/DebuggerContract.h +++ b/dev/DebuggerKit/DebuggerContract.h @@ -13,14 +13,20 @@ namespace DebuggerKit { class DebuggerContract; +/// =========================================================== /// /// \brief Process ID +/// =========================================================== /// typedef uint64_t ProcessID; +/// =========================================================== /// /// \brief Address type, a la BSD. +/// =========================================================== /// typedef char* CAddress; +/// =========================================================== /// /// \brief Debugger contract class in C++, as per the design states. /// \author Amlal El Mahrouss +/// =========================================================== /// class DebuggerContract { public: explicit DebuggerContract() = default; diff --git a/dev/DebuggerKit/NeKernelContract.h b/dev/DebuggerKit/NeKernelContract.h index 3a1fbad..669ee1f 100644 --- a/dev/DebuggerKit/NeKernelContract.h +++ b/dev/DebuggerKit/NeKernelContract.h @@ -27,6 +27,10 @@ namespace Detail { typedef int64_t dk_socket_type; } // namespace Detail +/// =========================================================== /// +/// \brief NeKernel Debugger Contract +/// \author Amlal El Mahrouss +/// =========================================================== /// class NeKernelContract final DK_DEBUGGER_CONTRACT { public: NeKernelContract(); diff --git a/dev/DebuggerKit/POSIXMachContract.h b/dev/DebuggerKit/POSIXMachContract.h index 2df6ef1..4c20d38 100644 --- a/dev/DebuggerKit/POSIXMachContract.h +++ b/dev/DebuggerKit/POSIXMachContract.h @@ -42,8 +42,10 @@ CK_IMPORT_C kern_return_t mach_vm_protect(vm_map_t target_task, mach_vm_address_ #define PTRACE_PEEKTEXT PT_READ_I namespace DebuggerKit::POSIX { -/// \brief POSIXMachContract engine interface class in C++ +/// =========================================================== /// +/// \brief POSIXMachContract engine class in C++ /// \author Amlal El Mahrouss +/// =========================================================== /// class POSIXMachContract final DK_DEBUGGER_CONTRACT { public: explicit POSIXMachContract() = default; diff --git a/dev/DebuggerKit/Platform.h b/dev/DebuggerKit/Platform.h index 7de443b..26f47ff 100644 --- a/dev/DebuggerKit/Platform.h +++ b/dev/DebuggerKit/Platform.h @@ -7,7 +7,9 @@ #pragma once +/// =========================================================== /// /// @author Amlal El Mahrouss +/// =========================================================== /// #include #include diff --git a/dev/DebuggerKit/Version.h b/dev/DebuggerKit/Version.h index 5aff977..d7e3985 100644 --- a/dev/DebuggerKit/Version.h +++ b/dev/DebuggerKit/Version.h @@ -6,7 +6,7 @@ #pragma once -#define kDistVersion "v0.0.6-debuggerkit" +#define kDistVersion "v0.0.7-debuggerkit" #define kDistVersionBCD 0x0001 #define ToString(X) Stringify(X) -- cgit v1.2.3