From ab5c964f5dc75eeefefd4af423bf6952497da7a4 Mon Sep 17 00:00:00 2001 From: Felix Morgner Date: Thu, 12 Oct 2023 16:16:59 +0200 Subject: docs: add basic documentation for asm_pointer --- docs/cross.rst | 9 +++++++++ docs/cross/memory.rst | 11 +++++++++++ docs/cross/memory/asm_pointer.rst | 10 ++++++++++ docs/index.rst | 2 ++ 4 files changed, 32 insertions(+) create mode 100644 docs/cross.rst create mode 100644 docs/cross/memory.rst create mode 100644 docs/cross/memory/asm_pointer.rst (limited to 'docs') diff --git a/docs/cross.rst b/docs/cross.rst new file mode 100644 index 0000000..542d76a --- /dev/null +++ b/docs/cross.rst @@ -0,0 +1,9 @@ +Platform-Independent Infrastructure +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + cross/* diff --git a/docs/cross/memory.rst b/docs/cross/memory.rst new file mode 100644 index 0000000..3a2c1c4 --- /dev/null +++ b/docs/cross/memory.rst @@ -0,0 +1,11 @@ +Memory Access and Management +============================ + +This sections details the platform-**independent** infrastructure for memory access and management. + +.. toctree:: + :maxdepth: 1 + :glob: + :caption: Types: + + memory/* diff --git a/docs/cross/memory/asm_pointer.rst b/docs/cross/memory/asm_pointer.rst new file mode 100644 index 0000000..70f5c01 --- /dev/null +++ b/docs/cross/memory/asm_pointer.rst @@ -0,0 +1,10 @@ +Access to Pointers Defined in Assembly +====================================== + +.. doxygenstruct:: teachos::memory::asm_pointer + :members: + +Specializations +--------------- + +.. doxygenstruct:: teachos::memory::asm_pointer< Type const > \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 44e7617..a804c88 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,8 @@ Welcome to TeachOS Kernel's documentation! :maxdepth: 2 :caption: Contents: + cross + Indices and tables ================== -- cgit v1.2.3