aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatteo Gmür <matteo.gmuer1@ost.ch>2024-12-09 12:03:39 +0000
committerMatteo Gmür <matteo.gmuer1@ost.ch>2024-12-09 12:03:39 +0000
commit50e2bda01928bfbad90a91439ac6326473a698b4 (patch)
tree64679fa4de2be0db4591c7933d6b331b6a00d760
parenta5c6d172b2a134f63387b0ed9055b48147f0b663 (diff)
downloadteachos-50e2bda01928bfbad90a91439ac6326473a698b4.tar.xz
teachos-50e2bda01928bfbad90a91439ac6326473a698b4.zip
Generate doyxgen files with build taks
-rw-r--r--CMakeLists.txt2
-rw-r--r--arch/x86_64/include/arch/memory/allocator/concept.hpp4
-rw-r--r--arch/x86_64/include/arch/memory/heap/concept.hpp3
3 files changed, 5 insertions, 4 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 3586669..12ac210 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -27,7 +27,7 @@ set(CMAKE_CXX_EXTENSIONS NO)
find_package("Doxygen")
-set(DOXYGEN_GENERATE_HTML NO)
+set(DOXYGEN_GENERATE_HTML YES)
set(DOXYGEN_GENERATE_XML YES)
set(DOXYGEN_EXCLUDE_PATTERNS "*.cpp")
set(DOXYGEN_OUTPUT_DIRECTORY "doxygen")
diff --git a/arch/x86_64/include/arch/memory/allocator/concept.hpp b/arch/x86_64/include/arch/memory/allocator/concept.hpp
index 18bb6bd..2d3f4ae 100644
--- a/arch/x86_64/include/arch/memory/allocator/concept.hpp
+++ b/arch/x86_64/include/arch/memory/allocator/concept.hpp
@@ -8,9 +8,7 @@
namespace teachos::arch::memory::allocator
{
/**
- * @brief Frame allocator concept
- *
- * @tparam T
+ * @brief Frame allocator concept required for allocating and deallocating physical frames in memory.
*/
template<typename T>
concept FrameAllocator = requires(T t, physical_frame const & a) {
diff --git a/arch/x86_64/include/arch/memory/heap/concept.hpp b/arch/x86_64/include/arch/memory/heap/concept.hpp
index 1cd24f4..e22e35f 100644
--- a/arch/x86_64/include/arch/memory/heap/concept.hpp
+++ b/arch/x86_64/include/arch/memory/heap/concept.hpp
@@ -8,6 +8,9 @@ namespace teachos::arch::memory::heap
std::size_t constexpr HEAP_START = 0x100000000;
std::size_t constexpr HEAP_SIZE = 100 * 1024;
+ /**
+ * @brief Heap allocator concept required for allocating and managing free space on the heap.
+ */
template<typename T>
concept HeapAllocator = requires(T t, uint8_t * pointer, std::size_t size) {
{ t.allocate(size) } -> std::same_as<uint8_t *>;