diff options
| author | Felix Morgner <felix.morgner@ost.ch> | 2026-08-31 13:13:16 +0200 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@ost.ch> | 2026-08-31 13:13:16 +0200 |
| commit | fd15eda1cf574d667fb04ebd2b51462ee8e7774e (patch) | |
| tree | 02568b23e9e9f5d138d4576bc19033f6e0a1ae5b /docs/kapi | |
| parent | ecf882dad2aaa6160e6c27277dceae935658b4cb (diff) | |
| download | kernel-fd15eda1cf574d667fb04ebd2b51462ee8e7774e.tar.xz kernel-fd15eda1cf574d667fb04ebd2b51462ee8e7774e.zip | |
docs: prepare for pages deployment
Diffstat (limited to 'docs/kapi')
| -rw-r--r-- | docs/kapi/capabilities.rst | 13 | ||||
| -rw-r--r-- | docs/kapi/cio.rst | 24 | ||||
| -rw-r--r-- | docs/kapi/cpu.rst | 24 | ||||
| -rw-r--r-- | docs/kapi/devices.rst | 22 | ||||
| -rw-r--r-- | docs/kapi/devices/busses.rst | 2 | ||||
| -rw-r--r-- | docs/kapi/interrupts.rst | 7 | ||||
| -rw-r--r-- | docs/kapi/memory.rst | 14 | ||||
| -rw-r--r-- | docs/kapi/system.rst | 14 |
8 files changed, 0 insertions, 120 deletions
diff --git a/docs/kapi/capabilities.rst b/docs/kapi/capabilities.rst deleted file mode 100644 index a4d7d999..00000000 --- a/docs/kapi/capabilities.rst +++ /dev/null @@ -1,13 +0,0 @@ -Capability Dispatch -=================== - -.. todo:: - Document the facet based capability dispatch mechanism. - -API Reference -------------- - -Classes -------- - -.. doxygenstruct:: kapi::capabilities::facet_id
\ No newline at end of file diff --git a/docs/kapi/cio.rst b/docs/kapi/cio.rst deleted file mode 100644 index 15b322fa..00000000 --- a/docs/kapi/cio.rst +++ /dev/null @@ -1,24 +0,0 @@ -Character I/O Interface -======================= - -The character I/O interface defines a simple API allowing the kernel to write characters to a platform's output device. - -API Reference -------------- - -Functions ---------- - -.. doxygenfunction:: kapi::cio::init -.. doxygenfunction:: kapi::cio::set_output_device -.. doxygenfunction:: kapi::cio::write - -Classes -------- - -.. doxygenstruct:: kapi::cio::output_device - -Enums ------ - -.. doxygenenum:: kapi::cio::output_stream diff --git a/docs/kapi/cpu.rst b/docs/kapi/cpu.rst deleted file mode 100644 index ab5d182f..00000000 --- a/docs/kapi/cpu.rst +++ /dev/null @@ -1,24 +0,0 @@ -CPU Interface -============= - -.. todo:: - Write an introduction to the CPU interface. - -Functions ---------- - -.. doxygenfunction:: kapi::cpu::dispatch -.. doxygenfunction:: kapi::cpu::halt -.. doxygenfunction:: kapi::cpu::init -.. doxygenfunction:: kapi::cpu::current_id - -Classes -------- - -.. doxygenstruct:: kapi::cpu::exception -.. doxygenstruct:: kapi::cpu::id - -Constants ---------- - -.. doxygenvariable:: kapi::cpu::invalid_id
\ No newline at end of file diff --git a/docs/kapi/devices.rst b/docs/kapi/devices.rst deleted file mode 100644 index 8b674e6e..00000000 --- a/docs/kapi/devices.rst +++ /dev/null @@ -1,22 +0,0 @@ -Device Interface -================ - -.. toctree:: - :maxdepth: 1 - :caption: Contents: - :glob: - - devices/* - -API Reference -------------- - -.. doxygenfunction:: kapi::devices::init -.. doxygenfunction:: kapi::devices::get_root_bus -.. doxygenfunction:: kapi::devices::remove_device -.. doxygenfunction:: kapi::devices::publish_facet(kstd::shared_ptr<device>, kstd::string) -.. doxygenfunction:: kapi::devices::publish_facet(kstd::shared_ptr<device>, kstd::string, Facet *) -.. doxygenfunction:: kapi::devices::init_platform_drivers -.. doxygenfunction:: kapi::devices::init_platform_devices -.. doxygenfunction:: kapi::devices::discover_cpu_topology -.. doxygenfunction:: kapi::devices::get_cpu_bus
\ No newline at end of file diff --git a/docs/kapi/devices/busses.rst b/docs/kapi/devices/busses.rst deleted file mode 100644 index 22b3a79e..00000000 --- a/docs/kapi/devices/busses.rst +++ /dev/null @@ -1,2 +0,0 @@ -Busses -======
\ No newline at end of file diff --git a/docs/kapi/interrupts.rst b/docs/kapi/interrupts.rst deleted file mode 100644 index f921b77e..00000000 --- a/docs/kapi/interrupts.rst +++ /dev/null @@ -1,7 +0,0 @@ -Interrupt Interface -=================== - -API Reference -------------- - -.. doxygenfile:: kapi/interrupts.hpp
\ No newline at end of file diff --git a/docs/kapi/memory.rst b/docs/kapi/memory.rst deleted file mode 100644 index 9ee15845..00000000 --- a/docs/kapi/memory.rst +++ /dev/null @@ -1,14 +0,0 @@ -Memory Interface -================ - -Kernel-defined API ------------------- - -.. doxygengroup:: kapi-memory-kernel-defined - :content-only: - -Platform-defined API --------------------- - -.. doxygengroup:: kapi-memory-platform-defined - :content-only: diff --git a/docs/kapi/system.rst b/docs/kapi/system.rst deleted file mode 100644 index 2eaea6de..00000000 --- a/docs/kapi/system.rst +++ /dev/null @@ -1,14 +0,0 @@ -System Interface -================ - -Kernel-defined API ------------------- - -.. doxygengroup:: kapi-system-kernel-defined - :content-only: - -Platform-defined API --------------------- - -.. doxygengroup:: kapi-system-platform-defined - :content-only: |