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.
---
 common/uapi/conf.c     | 7 +++++++
 common/uapi/dispatch.c | 5 +++++
 common/uapi/ipc.c      | 5 +++++
 common/uapi/mem.c      | 5 +++++
 common/uapi/proc.c     | 5 +++++
 common/uapi/timers.c   | 5 +++++
 6 files changed, 32 insertions(+)

(limited to 'common/uapi')

diff --git a/common/uapi/conf.c b/common/uapi/conf.c
index 25677ef..a30333b 100644
--- a/common/uapi/conf.c
+++ b/common/uapi/conf.c
@@ -1,3 +1,10 @@
+/**
+ * @file conf.c
+ * Runtime configuration sycall implementations.
+ *
+ * At the moment there are not runtime configuration parameters.
+ */
+
 #include <apos/power.h>
 #include <apos/sizes.h>
 #include <apos/uapi.h>
diff --git a/common/uapi/dispatch.c b/common/uapi/dispatch.c
index 5e2e788..1e72e77 100644
--- a/common/uapi/dispatch.c
+++ b/common/uapi/dispatch.c
@@ -1,3 +1,8 @@
+/**
+ * @file dispatch.c
+ * Syscall dispatch.
+ */
+
 #include <apos/uapi.h>
 
 static const sys_t syscall_table[] = {
diff --git a/common/uapi/ipc.c b/common/uapi/ipc.c
index 0d2d287..d3cbcd7 100644
--- a/common/uapi/ipc.c
+++ b/common/uapi/ipc.c
@@ -1,3 +1,8 @@
+/**
+ * @file ipc.c
+ * Interprocess communication syscall implementations.
+ */
+
 #include <apos/uapi.h>
 #include <apos/tcb.h>
 
diff --git a/common/uapi/mem.c b/common/uapi/mem.c
index 7526152..83d7289 100644
--- a/common/uapi/mem.c
+++ b/common/uapi/mem.c
@@ -1,3 +1,8 @@
+/**
+ * @file mem.c
+ * Memory handling syscall implementations.
+ */
+
 #include <apos/uapi.h>
 #include <apos/utils.h>
 #include <apos/vmem.h>
diff --git a/common/uapi/proc.c b/common/uapi/proc.c
index 3ce3bcb..43e825d 100644
--- a/common/uapi/proc.c
+++ b/common/uapi/proc.c
@@ -1,3 +1,8 @@
+/**
+ * @file proc.c
+ * Process/thread handling syscall implementations.
+ */
+
 #include <apos/uapi.h>
 
 SYSCALL_DEFINE0(create)()
diff --git a/common/uapi/timers.c b/common/uapi/timers.c
index 97a1d30..ca2443b 100644
--- a/common/uapi/timers.c
+++ b/common/uapi/timers.c
@@ -1,3 +1,8 @@
+/**
+ * @file timers.c
+ * Timer syscall implementations.
+ */
+
 #include <apos/timer.h>
 #include <apos/uapi.h>
 
-- 
cgit v1.3