From 72df0de8cb579fd96449d19eb57fc71335907a19 Mon Sep 17 00:00:00 2001
From: Kimplul <kimi.h.kuparinen@gmail.com>
Date: Sun, 22 May 2022 23:35:02 +0300
Subject: add @file info to all files

+ Next step, start documenting contents of each file.
---
 include/arch/arch.h  | 6 ++++++
 include/arch/cpu.h   | 6 ++++++
 include/arch/irq.h   | 6 ++++++
 include/arch/pmem.h  | 6 ++++++
 include/arch/timer.h | 6 ++++++
 include/arch/vmem.h  | 6 ++++++
 6 files changed, 36 insertions(+)

(limited to 'include/arch')

diff --git a/include/arch/arch.h b/include/arch/arch.h
index f684cf0..801e363 100644
--- a/include/arch/arch.h
+++ b/include/arch/arch.h
@@ -1,6 +1,12 @@
 #ifndef APOS_ARCH_H
 #define APOS_ARCH_H
 
+/**
+ * @file arch.h
+ * Arch-specific generic stuff, generally implemented in
+ * arch/whatever/kernel/main.c
+ */
+
 #include <apos/types.h>
 
 stat_t setup_arch(void *fdt);
diff --git a/include/arch/cpu.h b/include/arch/cpu.h
index c53a4d6..cf7abde 100644
--- a/include/arch/cpu.h
+++ b/include/arch/cpu.h
@@ -1,6 +1,12 @@
 #ifndef APOS_CPU_H
 #define APOS_CPU_H
 
+/**
+ * @file cpu.h
+ * Arch-specific cpu handling, generally implemented in
+ * arch/whatever/kernel/cpu.c
+ */
+
 #include <apos/types.h>
 #include <cpu.h>
 
diff --git a/include/arch/irq.h b/include/arch/irq.h
index 3ce6556..15ad893 100644
--- a/include/arch/irq.h
+++ b/include/arch/irq.h
@@ -1,6 +1,12 @@
 #ifndef APOS_IRQ_H
 #define APOS_IRQ_H
 
+/**
+ * @file irq.h
+ * Arch-specific interrupt handling, generally implemented in
+ * arch/whatever/kernel/irq.c
+ */
+
 void init_irq(void *fdt);
 void handle_irq();
 void enable_irq();
diff --git a/include/arch/pmem.h b/include/arch/pmem.h
index 08a38ed..e492426 100644
--- a/include/arch/pmem.h
+++ b/include/arch/pmem.h
@@ -1,6 +1,12 @@
 #ifndef APOS_ARCH_PMEM_H
 #define APOS_ARCH_PMEM_H
 
+/**
+ * @file pmem.h
+ * Arch-specific physical memory handling, generally implemented in
+ * arch/whatever/kernel/pmem.c
+ */
+
 #include <apos/mem.h> /* NUM_ORDERS */
 #include <apos/types.h>
 #include <pmem.h>
diff --git a/include/arch/timer.h b/include/arch/timer.h
index 6d63565..b4b2197 100644
--- a/include/arch/timer.h
+++ b/include/arch/timer.h
@@ -1,6 +1,12 @@
 #ifndef APOS_ARCH_TIMER_H
 #define APOS_ARCH_TIMER_H
 
+/**
+ * @file timer.h
+ * Arch-specific timer handling, generally implemented in
+ * arch/whatever/timer.c
+ */
+
 #include <apos/timer.h>
 
 /* return hardware timer frequency */
diff --git a/include/arch/vmem.h b/include/arch/vmem.h
index 03bffb3..e123b47 100644
--- a/include/arch/vmem.h
+++ b/include/arch/vmem.h
@@ -1,6 +1,12 @@
 #ifndef APOS_ARCH_PAGES_H
 #define APOS_ARCH_PAGES_H
 
+/**
+ * @file vmem.h
+ * Arch-specific virtual memory handling, generally implemented in
+ * arch/whatever/kernel/vmem.c
+ */
+
 #include <vmem.h>
 
 stat_t map_vpage(struct vmem *branch, pm_t paddr, vm_t vaddr, vmflags_t flags,
-- 
cgit v1.3