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 /docs/kapi/cio.rst | |
| parent | 51bd0daba2fa3cd42242b2c07cf4851bc7845fb1 (diff) | |
| download | kernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.tar.xz kernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.zip | |
docs: draft new documentation structure
Diffstat (limited to 'docs/kapi/cio.rst')
| -rw-r--r-- | docs/kapi/cio.rst | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/docs/kapi/cio.rst b/docs/kapi/cio.rst index 62a36398..15b322fa 100644 --- a/docs/kapi/cio.rst +++ b/docs/kapi/cio.rst @@ -1,17 +1,24 @@ Character I/O Interface ======================= -.. doxygengroup:: kapi-cio - :content-only: +The character I/O interface defines a simple API allowing the kernel to write characters to a platform's output device. -Kernel-defined API ------------------- +API Reference +------------- -.. doxygengroup:: kapi-cio-kernel-defined - :content-only: +Functions +--------- -Platform-defined API --------------------- +.. doxygenfunction:: kapi::cio::init +.. doxygenfunction:: kapi::cio::set_output_device +.. doxygenfunction:: kapi::cio::write -.. doxygengroup:: kapi-cio-platform-defined - :content-only: +Classes +------- + +.. doxygenstruct:: kapi::cio::output_device + +Enums +----- + +.. doxygenenum:: kapi::cio::output_stream |