From 72df0de8cb579fd96449d19eb57fc71335907a19 Mon Sep 17 00:00:00 2001 From: Kimplul 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/assert.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'include/apos/assert.h') 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 #include -- cgit v1.3