aboutsummaryrefslogtreecommitdiff
path: root/docs/kapi/cpu.rst
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2026-08-20 16:04:48 +0200
committerFelix Morgner <felix.morgner@ost.ch>2026-08-20 16:04:48 +0200
commit5117ee7b57f7e349d35c88d31b0d3714a2afbcc6 (patch)
tree12d2bae0dbfa74ed6f9161952f134ea1c520b15a /docs/kapi/cpu.rst
parent51bd0daba2fa3cd42242b2c07cf4851bc7845fb1 (diff)
downloadkernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.tar.xz
kernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.zip
docs: draft new documentation structure
Diffstat (limited to 'docs/kapi/cpu.rst')
-rw-r--r--docs/kapi/cpu.rst27
1 files changed, 17 insertions, 10 deletions
diff --git a/docs/kapi/cpu.rst b/docs/kapi/cpu.rst
index 0793dd8c..ab5d182f 100644
--- a/docs/kapi/cpu.rst
+++ b/docs/kapi/cpu.rst
@@ -1,17 +1,24 @@
CPU Interface
=============
-.. doxygengroup:: kapi-cpu
- :content-only:
+.. todo::
+ Write an introduction to the CPU interface.
-Kernel-defined API
-------------------
+Functions
+---------
-.. doxygengroup:: kapi-cpu-kernel-defined
- :content-only:
+.. doxygenfunction:: kapi::cpu::dispatch
+.. doxygenfunction:: kapi::cpu::halt
+.. doxygenfunction:: kapi::cpu::init
+.. doxygenfunction:: kapi::cpu::current_id
-Platform-defined API
---------------------
+Classes
+-------
-.. doxygengroup:: kapi-cpu-platform-defined
- :content-only:
+.. doxygenstruct:: kapi::cpu::exception
+.. doxygenstruct:: kapi::cpu::id
+
+Constants
+---------
+
+.. doxygenvariable:: kapi::cpu::invalid_id \ No newline at end of file