1 files changed, 14 insertions, 0 deletions
diff --git a/include/apos/assert.h b/include/apos/assert.h
index f3d9a4d..eed521c 100644
--- a/include/apos/assert.h
+++ b/include/apos/assert.h
@@ -1,6 +1,20 @@
 #ifndef APOS_ASSERT_H
 #define APOS_ASSERT_H
 
+/**
+ * @file assert.h
+ * Assertions. Note that contrary to how assertios usually function, apos has
+ * three different levels of assertions: Catastrophic, hard and soft.
+ *
+ * Soft assertions merely warn about something that might cause issues, but let
+ * the execution continue normally.
+ *
+ * Hard assertions warn about the assertion not holding and returns from the
+ * function.
+ *
+ * Catastrophic assertions warn about the assertion and crash the kernel.
+ */
+
 #include <apos/debug.h>
 #include <apos/utils.h>