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/apos/lock.h | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

(limited to 'include/apos/lock.h')

diff --git a/include/apos/lock.h b/include/apos/lock.h
index 178140b..2fac160 100644
--- a/include/apos/lock.h
+++ b/include/apos/lock.h
@@ -1,5 +1,11 @@
-#ifndef LOCK_H
-#define LOCK_H
+#ifndef APOS_LOCK_H
+#define APOS_LOCK_H
+
+/**
+ * @file lock.h
+ * Atomic locks, currently only \ref spin_lock and \ref spin_unlock. Mutex is
+ * probably overkill for this project.
+ */
 
 #include <apos/atomic.h>
 #include <apos/irq.h>
@@ -23,4 +29,4 @@ static inline void spin_unlock(spinlock_t *lck)
 	enable_irq();
 }
 
-#endif /* LOCK_H */
+#endif /* APOS_LOCK_H */
-- 
cgit v1.3