aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorKimplul <kimi.h.kuparinen@gmail.com>2022-05-22 23:35:02 +0300
committerKimplul <kimi.h.kuparinen@gmail.com>2022-05-22 23:35:02 +0300
commit72df0de8cb579fd96449d19eb57fc71335907a19 (patch)
tree6a0a24478fe95f009619787afd24ddfe5df8cfd7 /lib
parentd99be9e2912e0726ab779053b43a89e3b9e21490 (diff)
downloadkmi-72df0de8cb579fd96449d19eb57fc71335907a19.tar.gz
kmi-72df0de8cb579fd96449d19eb57fc71335907a19.zip
add @file info to all files
+ Next step, start documenting contents of each file.
Diffstat (limited to 'lib')
-rw-r--r--lib/fdt.c5
-rw-r--r--lib/fdt_addresses.c5
-rw-r--r--lib/fdt_dbg.c5
-rw-r--r--lib/fdt_empty_tree.c5
-rw-r--r--lib/fdt_ro.c5
-rw-r--r--lib/fdt_rw.c5
-rw-r--r--lib/fdt_strerror.c5
-rw-r--r--lib/fdt_sw.c5
-rw-r--r--lib/fdt_wip.c5
-rw-r--r--lib/ubsan.c12
10 files changed, 53 insertions, 4 deletions
diff --git a/lib/fdt.c b/lib/fdt.c
index 2d910c0..800d16f 100644
--- a/lib/fdt.c
+++ b/lib/fdt.c
@@ -1,2 +1,7 @@
+/**
+ * @file fdt.c
+ * Wrapper to libfdt/fdt.c, sets up the environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt.c"
diff --git a/lib/fdt_addresses.c b/lib/fdt_addresses.c
index f7ac8ae..942d3a8 100644
--- a/lib/fdt_addresses.c
+++ b/lib/fdt_addresses.c
@@ -1,2 +1,7 @@
+/**
+ * @file
+ * Wrapper to libfdt fdt_addresses.c, sets up the environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt_addresses.c"
diff --git a/lib/fdt_dbg.c b/lib/fdt_dbg.c
index bf8e2d9..377ecdd 100644
--- a/lib/fdt_dbg.c
+++ b/lib/fdt_dbg.c
@@ -1,3 +1,8 @@
+/**
+ * @file fdt_dbg.c
+ * Dump fdt info to serial.
+ */
+
#include <apos/debug.h>
#include <libfdt.h>
diff --git a/lib/fdt_empty_tree.c b/lib/fdt_empty_tree.c
index a057358..bdfb9cb 100644
--- a/lib/fdt_empty_tree.c
+++ b/lib/fdt_empty_tree.c
@@ -1,2 +1,7 @@
+/**
+ * @file fdt_empty_tree.c
+ * Wrapper around libfdt/fdt_empty_tree.c, sets up environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt_empty_tree.c"
diff --git a/lib/fdt_ro.c b/lib/fdt_ro.c
index b60a1a8..4528c60 100644
--- a/lib/fdt_ro.c
+++ b/lib/fdt_ro.c
@@ -1,2 +1,7 @@
+/**
+ * @file fdt_ro.c
+ * Wrapper around libfdt/fdt_ro.c, sets up the environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt_ro.c"
diff --git a/lib/fdt_rw.c b/lib/fdt_rw.c
index 1bb8ed4..79e7fa9 100644
--- a/lib/fdt_rw.c
+++ b/lib/fdt_rw.c
@@ -1,2 +1,7 @@
+/**
+ * @file fdt_rw.c
+ * Wrapper around libfdt/fdt_rw.c, sets up the environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt_rw.c"
diff --git a/lib/fdt_strerror.c b/lib/fdt_strerror.c
index f442010..70791b7 100644
--- a/lib/fdt_strerror.c
+++ b/lib/fdt_strerror.c
@@ -1,2 +1,7 @@
+/**
+ * @file fdt_strerror.c
+ * Wrapper around libfdt/fdt_strerror.c, sets up the environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt_strerror.c"
diff --git a/lib/fdt_sw.c b/lib/fdt_sw.c
index b5b1257..5bb8991 100644
--- a/lib/fdt_sw.c
+++ b/lib/fdt_sw.c
@@ -1,2 +1,7 @@
+/**
+ * @file fdt_sw.c
+ * Wrapper around libfdt/fdt_sw.c, sets up the environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt_sw.c"
diff --git a/lib/fdt_wip.c b/lib/fdt_wip.c
index ee3b4d3..e5dab53 100644
--- a/lib/fdt_wip.c
+++ b/lib/fdt_wip.c
@@ -1,2 +1,7 @@
+/**
+ * @file fdt_wip.c
+ * Wrapper around libfdt/fdt_wip.c, sets up the environment.
+ */
+
#include "libfdt_env.h"
#include "../dtc/libfdt/fdt_wip.c"
diff --git a/lib/ubsan.c b/lib/ubsan.c
index 7f4df2a..8b103df 100644
--- a/lib/ubsan.c
+++ b/lib/ubsan.c
@@ -1,10 +1,14 @@
+/**
+ * @file ubsan.c
+ * Tiny undefined behaviour sanitizer, mostly lifted from
+ * https://github.com/Abb1x/tinyubsan/blob/master/src/tinyubsan.c
+ *
+ * \todo: Add in more runtime info.
+ */
+
#include <apos/types.h>
#include <apos/debug.h>
-/* mostly lifted from https://github.com/Abb1x/tinyubsan/blob/master/src/tinyubsan.c */
-/* TODO: while this is really useful, it would probably be a good idea to add in
- * more runtime info, see linux for example */
-
struct tu_source_location {
const char *file;
uint32_t line;