kernel: demand_paging: add doc to enum arch_page_location

This adds doc to enum arch_page_location. Signed-off-by: Daniel Leung <[email protected]>
phan-uy-vu · Oct 9, 2023 · dd6a7eb · dd6a7eb
1 parent 77dc741
commit dd6a7eb
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/kernel/include/kernel_arch_interface.h b/kernel/include/kernel_arch_interface.h
@@ -402,9 +402,17 @@ void arch_mem_page_in(void *addr, uintptr_t phys);
  */
 void arch_mem_scratch(uintptr_t phys);
 
+/**
+ * Status of a particular page location.
+ */
 enum arch_page_location {
+	/** The page has been evicted to the backing store. */
 	ARCH_PAGE_LOCATION_PAGED_OUT,
+
+	/** The page is resident in memory. */
 	ARCH_PAGE_LOCATION_PAGED_IN,
+
+	/** The page is not mapped. */
 	ARCH_PAGE_LOCATION_BAD
 };