diff options
-rwxr-xr-x | scratch/find-undocumented-classes.sh | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/scratch/find-undocumented-classes.sh b/scratch/find-undocumented-classes.sh new file mode 100755 index 000000000..58a133b5c --- /dev/null +++ b/scratch/find-undocumented-classes.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +# finds undocumented classes in the current directory (recursive) + +filter= +quiet=n +if [ "$1" = "-q" ]; then + filter=">/dev/null" + quiet=y +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 +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 'Warning: Compound.*is not documented' +rm -rf $doxygen + +# vim:set shiftwidth=4 softtabstop=4 expandtab: |