diff options
| author | Felix Morgner <felix.morgner@ost.ch> | 2026-08-20 16:04:48 +0200 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@ost.ch> | 2026-08-20 16:04:48 +0200 |
| commit | 5117ee7b57f7e349d35c88d31b0d3714a2afbcc6 (patch) | |
| tree | 12d2bae0dbfa74ed6f9161952f134ea1c520b15a /kapi | |
| parent | 51bd0daba2fa3cd42242b2c07cf4851bc7845fb1 (diff) | |
| download | kernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.tar.xz kernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.zip | |
docs: draft new documentation structure
Diffstat (limited to 'kapi')
| -rw-r--r-- | kapi/kapi.dox | 12 | ||||
| -rw-r--r-- | kapi/kapi/cio.hpp | 8 | ||||
| -rw-r--r-- | kapi/kapi/cio/output_device.hpp | 5 | ||||
| -rw-r--r-- | kapi/kapi/cpu.hpp | 9 | ||||
| -rw-r--r-- | kapi/kapi/devices.hpp | 4 |
5 files changed, 6 insertions, 32 deletions
diff --git a/kapi/kapi.dox b/kapi/kapi.dox deleted file mode 100644 index 09b06e44..00000000 --- a/kapi/kapi.dox +++ /dev/null @@ -1,12 +0,0 @@ -//! @namespace kapi -//! The Kernel/Platform API -//! -//! This namespace defines the interface between the platform independent kernel and each supported platform. - -//! @defgroup kapi-kernel-defined Kernel-defined API - -//! @defgroup kapi-platform-defined Platform-defined API - -//! @defgroup kapi-boot-modules Boot Modules API - -//! @defgroup kapi-boot_modules-kernel-defined Boot Modules API (kernel defined) diff --git a/kapi/kapi/cio.hpp b/kapi/kapi/cio.hpp index 5c4cc8b7..f6906673 100644 --- a/kapi/kapi/cio.hpp +++ b/kapi/kapi/cio.hpp @@ -11,11 +11,7 @@ namespace kapi::cio { - //! @addtogroup kapi-cio - //! @{ - //! @} - - //! @addtogroup kapi-cio-kernel-defined + //! @name Kernel-defined API //! @{ //! Set the currently active output device. @@ -32,7 +28,7 @@ namespace kapi::cio //! @} - //! @addtogroup kapi-cio-platform-defined + //! @name Platform-defined API //! @{ //! Initialize the character I/O subsystem. diff --git a/kapi/kapi/cio/output_device.hpp b/kapi/kapi/cio/output_device.hpp index c241a10c..9fe25577 100644 --- a/kapi/kapi/cio/output_device.hpp +++ b/kapi/kapi/cio/output_device.hpp @@ -8,9 +8,6 @@ namespace kapi::cio { - //! @addtogroup kapi-cio - //! @{ - enum struct output_stream { stdout, @@ -37,8 +34,6 @@ namespace kapi::cio output_device() = default; }; - //! @} - } // namespace kapi::cio #endif diff --git a/kapi/kapi/cpu.hpp b/kapi/kapi/cpu.hpp index 7337a45a..ce35c18b 100644 --- a/kapi/kapi/cpu.hpp +++ b/kapi/kapi/cpu.hpp @@ -12,9 +12,6 @@ namespace kapi::cpu { - //! @addtogroup kapi-cpu - //! @{ - //! An exception originating from the CPU directly. //! //! Exception generally model interrupts that are synchronous to the instruction stream. This means that they do not @@ -74,9 +71,7 @@ namespace kapi::cpu //! The invalid CPU id. constexpr auto static invalid_id = id{std::numeric_limits<std::uint64_t>::max()}; - //! @} - - //! @addtogroup kapi-cpu-kernel-defined + //! @name Kernel-defined API //! @{ //! Dispatch an exception to the appropriate handler. @@ -87,7 +82,7 @@ namespace kapi::cpu //! @} - //! @addtogroup kapi-cpu-platform-defined + //! @name Platform-defined API //! @{ //! Halt the CPU. diff --git a/kapi/kapi/devices.hpp b/kapi/kapi/devices.hpp index 0781357c..21ecde14 100644 --- a/kapi/kapi/devices.hpp +++ b/kapi/kapi/devices.hpp @@ -21,7 +21,7 @@ namespace kapi::devices { - //! @addtogroup kapi-devices-kernel-defined + //! @name Kernel-defined API //! @{ //! Initialize the kernel's device management subsystem. @@ -65,7 +65,7 @@ namespace kapi::devices //! @} - //! @addtogroup kapi-devices-platform-defined + //! @name Platform-defined API //! @{ //! Initialize the platform's drivers. |