bin/find-undocumented-classes

   1 #!/usr/bin/env bash
   2
   3 # finds undocumented classes in the current directory (recursive)
   4
   5 type -p doxygen >/dev/null || exit
   6
   7 filter=
   8 quiet=n
   9 if [ "$1" = "-q" ]; then
  10     filter=">/dev/null"
  11     quiet=y
  12     shift
  13 fi
  14
  15 doxygen=$(mktemp -d)
  16 eval doxygen -g $doxygen/doxygen.cfg $filter
  17 sed -i "/HTML_OUTPUT/s|html|$doxygen/html|" $doxygen/doxygen.cfg
  18 sed -i '/GENERATE_LATEX/s/= YES/= NO/' $doxygen/doxygen.cfg
  19 sed -i '/RECURSIVE/s/= NO/= YES/' $doxygen/doxygen.cfg
  20 # do we have any arguments?
  21 if [ -n "$*" ]; then
  22     sed -i "/^INPUT[^_]/s|=.*|= $*|" $doxygen/doxygen.cfg
  23 fi
  24 eval doxygen $doxygen/doxygen.cfg $filter 2> $doxygen/errors.txt
  25 if [ "$quiet" == "n" ]; then
  26     echo
  27     echo "The following classes are undocumented:"
  28     echo
  29 fi
  30 cat $doxygen/errors.txt|grep -i 'Warning: Compound.*is not documented'
  31 rm -rf $doxygen
  32
  33 # vim:set shiftwidth=4 softtabstop=4 expandtab: