summaryrefslogtreecommitdiff
path: root/bin/find-undocumented-classes
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@frugalware.org>2011-01-20 00:16:35 +0100
committerMiklos Vajna <vmiklos@frugalware.org>2011-01-20 00:17:54 +0100
commit2ce4895f860e3d8b7c301e8cbc479d7b352e6c38 (patch)
tree1f0cb746578d4c7d60f637d8bcd6fa3348d1c72e /bin/find-undocumented-classes
parent3b1a33287a714fcc4c531181f47a79a2dc559f53 (diff)
find-undocumented-classes: move from build repo
Diffstat (limited to 'bin/find-undocumented-classes')
-rwxr-xr-xbin/find-undocumented-classes31
1 files changed, 31 insertions, 0 deletions
diff --git a/bin/find-undocumented-classes b/bin/find-undocumented-classes
new file mode 100755
index 000000000000..3040660eefa0
--- /dev/null
+++ b/bin/find-undocumented-classes
@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# finds undocumented classes in the current directory (recursive)
+
+filter=
+quiet=n
+if [ "$1" = "-q" ]; then
+ filter=">/dev/null"
+ quiet=y
+ shift
+fi
+
+doxygen=$(mktemp -d)
+eval doxygen -g $doxygen/doxygen.cfg $filter
+sed -i "/HTML_OUTPUT/s|html|$doxygen/html|" $doxygen/doxygen.cfg
+sed -i '/GENERATE_LATEX/s/= YES/= NO/' $doxygen/doxygen.cfg
+sed -i '/RECURSIVE/s/= NO/= YES/' $doxygen/doxygen.cfg
+# do we have any arguments?
+if [ -n "$*" ]; then
+ sed -i "/^INPUT[^_]/s|=.*|= $*|" $doxygen/doxygen.cfg
+fi
+eval doxygen $doxygen/doxygen.cfg $filter 2> $doxygen/errors.txt
+if [ "$quiet" == "n" ]; then
+ echo
+ echo "The following classes are undocumented:"
+ echo
+fi
+cat $doxygen/errors.txt|grep -i 'Warning: Compound.*is not documented'
+rm -rf $doxygen
+
+# vim:set shiftwidth=4 softtabstop=4 expandtab: