Added check for documentation comments to check_all.sh

Author: Seeker04

src/plwm.pl

@@ -460,7 +460,7 @@
 %  @arg OnlyVisual whether to unfocus only visually
 unfocus_onlyvisual(OnlyVisual) :- active_mon_ws(ActMon, ActWs), unfocus_at_onlyvisual(ActMon-ActWs, OnlyVisual).
 
-%! unfocus_onlyvisual(++At:integer-atom, ++OnlyVisual:bool) is det
+%! unfocus_at_onlyvisual(++At:integer-atom, ++OnlyVisual:bool) is det
 %
 %  Unfocuses the active window on the target monitor-workspace.
 %  This entails removing the focused status, adjusting the ActiveWindow netatom

tests/check_all.sh

@@ -114,6 +114,23 @@ echo "----------------------------------------------------------------------"
 make cppcheck
 make clang-tidy
 
+echo
+echo "----------------------------------------------------------------------"
+echo "Checking documentation comments"
+echo "----------------------------------------------------------------------"
+
+preds=$(egrep -h "^[a-z_]+[^_]\(.*\)(:-|.)" src/*.pl | cut -d'(' -f1 | sort -u | grep -vx "version")
+
+# note: we ignore version/0 and local helpers suffixed with an underscore e.g. valid_set_/2
+
+undocumented=""
+for pred in $preds; do
+	grep -q "^%! $pred" src/*.pl || undocumented="$undocumented\n$pred"
+done
+
+[ -z "$undocumented" ] && echo "documentation comments OK" \
+|| (echo -e "Predicates with no documentation comment:$undocumented"; false)
+
 echo
 echo "----------------------------------------------------------------------"
 echo "Unit tests"