aboutsummaryrefslogtreecommitdiff
path: root/kapi/kapi/memory
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2026-08-19 17:06:46 +0200
committerFelix Morgner <felix.morgner@ost.ch>2026-08-19 17:06:46 +0200
commit24d2d7dccace6f5a0bb4e2eb0f9e51cff06103b2 (patch)
treef4591ce8f20de3e6d7124f4d3f91c74b84e8bc09 /kapi/kapi/memory
parentbffc20aa863f38f97cd5a5798c4b86ffe84b75f4 (diff)
downloadkernel-24d2d7dccace6f5a0bb4e2eb0f9e51cff06103b2.tar.xz
kernel-24d2d7dccace6f5a0bb4e2eb0f9e51cff06103b2.zip
chore: normalize kapi doc comments
Diffstat (limited to 'kapi/kapi/memory')
-rw-r--r--kapi/kapi/memory/address.hpp7
-rw-r--r--kapi/kapi/memory/chunk.hpp6
-rw-r--r--kapi/kapi/memory/frame.hpp5
-rw-r--r--kapi/kapi/memory/frame_allocator.hpp5
-rw-r--r--kapi/kapi/memory/layout.hpp5
-rw-r--r--kapi/kapi/memory/page.hpp6
-rw-r--r--kapi/kapi/memory/page_mapper.hpp6
7 files changed, 34 insertions, 6 deletions
diff --git a/kapi/kapi/memory/address.hpp b/kapi/kapi/memory/address.hpp
index 8ed6d37a..a7f5ac92 100644
--- a/kapi/kapi/memory/address.hpp
+++ b/kapi/kapi/memory/address.hpp
@@ -15,7 +15,9 @@
namespace kapi::memory
{
- //! @qualifier kernel-defined
+ //! @addtogroup kapi-memory
+ //! @{
+
//! A tag for different address types.
enum struct address_type : bool
{
@@ -23,7 +25,6 @@ namespace kapi::memory
physical,
};
- //! @qualifier kernel-defined
//! A physical or virtual address.
//!
//! This convenience wrapper type is used to ensure that no linear address is passed where a physical one is expected
@@ -219,6 +220,8 @@ namespace kapi::memory
//! A physical address.
using physical_address = address<address_type::physical>;
+ //! @}
+
} // namespace kapi::memory
namespace kstd
diff --git a/kapi/kapi/memory/chunk.hpp b/kapi/kapi/memory/chunk.hpp
index 45e2ccfd..987c41f4 100644
--- a/kapi/kapi/memory/chunk.hpp
+++ b/kapi/kapi/memory/chunk.hpp
@@ -11,7 +11,9 @@
namespace kapi::memory
{
- //! @qualifier kernel-defined
+ //! @addtogroup kapi-memory
+ //! @{
+
//! A fixed-size unit of memory, indexed by a number.
//!
//! @tparam ChunkType The CRTP type of the deriving class
@@ -104,6 +106,8 @@ namespace kapi::memory
std::size_t m_number{};
};
+ //! @}
+
} // namespace kapi::memory
#endif \ No newline at end of file
diff --git a/kapi/kapi/memory/frame.hpp b/kapi/kapi/memory/frame.hpp
index e423fa4f..aafca5c7 100644
--- a/kapi/kapi/memory/frame.hpp
+++ b/kapi/kapi/memory/frame.hpp
@@ -11,8 +11,9 @@
namespace kapi::memory
{
+ //! @addtogroup kapi-memory
+ //! @{
- //! @qualifier kernel-defined
//! A handle to a frame of physical memory.
//!
//! @note Contrary to the address types, this type is modeled using inheritance to support future extensions.
@@ -43,6 +44,8 @@ namespace kapi::memory
{}
};
+ //! @}
+
} // namespace kapi::memory
#endif \ No newline at end of file
diff --git a/kapi/kapi/memory/frame_allocator.hpp b/kapi/kapi/memory/frame_allocator.hpp
index 784ea932..783bd3cb 100644
--- a/kapi/kapi/memory/frame_allocator.hpp
+++ b/kapi/kapi/memory/frame_allocator.hpp
@@ -12,6 +12,9 @@
namespace kapi::memory
{
+ //! @addtogroup kapi-memory
+ //! @{
+
//! The interface of all frame allocators.
//!
//! A frame allocator is responsible for the allocation, and deallocation, of frames of physical memory. Frames
@@ -61,6 +64,8 @@ namespace kapi::memory
frame_allocator() = default;
};
+ //! @}
+
} // namespace kapi::memory
#endif // TEACHOS_KAPI_MEMORY_FRAME_ALLOCATOR_HPP \ No newline at end of file
diff --git a/kapi/kapi/memory/layout.hpp b/kapi/kapi/memory/layout.hpp
index bcb27fbc..3dc5882e 100644
--- a/kapi/kapi/memory/layout.hpp
+++ b/kapi/kapi/memory/layout.hpp
@@ -10,6 +10,9 @@
namespace kapi::memory
{
+ //! @addtogroup kapi-memory
+ //! @{
+
//! The size of a single page of virtual memory.
//!
//! Platforms that use different sizes of pages are expected to emulate 4 KiB pages towards the kernel.
@@ -49,6 +52,8 @@ namespace kapi::memory
return physical_address{address.raw() - higher_half_direct_map_base.raw()};
}
+ //! @}
+
} // namespace kapi::memory
#endif \ No newline at end of file
diff --git a/kapi/kapi/memory/page.hpp b/kapi/kapi/memory/page.hpp
index d9875346..2a609833 100644
--- a/kapi/kapi/memory/page.hpp
+++ b/kapi/kapi/memory/page.hpp
@@ -12,7 +12,9 @@
namespace kapi::memory
{
- //! @qualifier kernel-defined
+ //! @addtogroup kapi-memory
+ //! @{
+
//! A handle to a page of virtual memory.
//!
//! @note Contrary to the address types, this type is modeled using inheritance to support future extensions.
@@ -33,6 +35,8 @@ namespace kapi::memory
{}
};
+ //! @}
+
} // namespace kapi::memory
#endif \ No newline at end of file
diff --git a/kapi/kapi/memory/page_mapper.hpp b/kapi/kapi/memory/page_mapper.hpp
index ec7e7c68..3deb4702 100644
--- a/kapi/kapi/memory/page_mapper.hpp
+++ b/kapi/kapi/memory/page_mapper.hpp
@@ -15,7 +15,9 @@
namespace kapi::memory
{
- //! @qualifier platform-implemented
+ //! @addtogroup kapi-memory
+ //! @{
+
//! The interface of a type allowing the mapping, and unmapping, of pages onto frames.
struct page_mapper
{
@@ -77,6 +79,8 @@ namespace kapi::memory
page_mapper() = default;
};
+ //! @}
+
} // namespace kapi::memory
namespace kstd