diff options
| author | Felix Morgner <felix.morgner@ost.ch> | 2026-04-02 20:04:07 +0200 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@ost.ch> | 2026-04-02 20:04:07 +0200 |
| commit | 4cce84317474dd14da806d3ddc7f69ef11356b5f (patch) | |
| tree | 5c03f02bc42429d8ed228faabf728d74b345ae89 /docs/kapi | |
| parent | b2c3f25b453f1b71552fd93de8d11efbda36fcd1 (diff) | |
| download | teachos-4cce84317474dd14da806d3ddc7f69ef11356b5f.tar.xz teachos-4cce84317474dd14da806d3ddc7f69ef11356b5f.zip | |
docs: begin breathe documentation
Diffstat (limited to 'docs/kapi')
| -rw-r--r-- | docs/kapi/cio.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/cpu.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/devices.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/interrupts.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/memory.rst | 14 | ||||
| -rw-r--r-- | docs/kapi/system.rst | 14 |
6 files changed, 96 insertions, 0 deletions
diff --git a/docs/kapi/cio.rst b/docs/kapi/cio.rst new file mode 100644 index 0000000..62a3639 --- /dev/null +++ b/docs/kapi/cio.rst @@ -0,0 +1,17 @@ +Character I/O Interface +======================= + +.. doxygengroup:: kapi-cio + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-cio-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-cio-platform-defined + :content-only: diff --git a/docs/kapi/cpu.rst b/docs/kapi/cpu.rst new file mode 100644 index 0000000..0793dd8 --- /dev/null +++ b/docs/kapi/cpu.rst @@ -0,0 +1,17 @@ +CPU Interface +============= + +.. doxygengroup:: kapi-cpu + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-cpu-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-cpu-platform-defined + :content-only: diff --git a/docs/kapi/devices.rst b/docs/kapi/devices.rst new file mode 100644 index 0000000..c9853a1 --- /dev/null +++ b/docs/kapi/devices.rst @@ -0,0 +1,17 @@ +Device Interface +================ + +.. doxygengroup:: kapi-devices + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-devices-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-devices-platform-defined + :content-only: diff --git a/docs/kapi/interrupts.rst b/docs/kapi/interrupts.rst new file mode 100644 index 0000000..7150f07 --- /dev/null +++ b/docs/kapi/interrupts.rst @@ -0,0 +1,17 @@ +Interrupt Interface +=================== + +.. doxygengroup:: kapi-interrupts + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-interrupts-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-interrupts-platform-defined + :content-only: diff --git a/docs/kapi/memory.rst b/docs/kapi/memory.rst new file mode 100644 index 0000000..9ee1584 --- /dev/null +++ b/docs/kapi/memory.rst @@ -0,0 +1,14 @@ +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 new file mode 100644 index 0000000..2eaea6d --- /dev/null +++ b/docs/kapi/system.rst @@ -0,0 +1,14 @@ +System Interface +================ + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-system-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-system-platform-defined + :content-only: |