aboutsummaryrefslogtreecommitdiff
path: root/scripts/warn-undocumented
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 /scripts/warn-undocumented
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 'scripts/warn-undocumented')
-rwxr-xr-xscripts/warn-undocumented6
1 files changed, 6 insertions, 0 deletions
diff --git a/scripts/warn-undocumented b/scripts/warn-undocumented
new file mode 100755
index 0000000..78f1401
--- /dev/null
+++ b/scripts/warn-undocumented
@@ -0,0 +1,6 @@
+#!/bin/sh
+# look through all files for either @file or \file, grep -c will report
+# ./example.file:0 if it is not found.
+find arch lib common include -iname '*.[ch]' -exec \
+ grep -c '[@\]file' {} \+ \
+ | awk -F':' '$2 == 0 {print "Undocumented file:", $1}'