Ver código fonte

tools/dev/functions_undocumented.sh: tool to check if some public functions are not documented

Nathalie Furmento 13 anos atrás
pai
commit
34762fc0b4
1 arquivos alterados com 16 adições e 0 exclusões
  1. 16 0
      tools/dev/functions_undocumented.sh

+ 16 - 0
tools/dev/functions_undocumented.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+stcolor=$(tput sgr0)
+redcolor=$(tput setaf 1)
+
+functions=$(grep -rs 'starpu.*(.*);' include | awk -F':' '{print $2}' | sed 's/(.*//' | sed 's/.* //'| tr -d ' ' | tr -d '*')
+
+for func in $functions ; do
+    #echo Processing function $func
+    x=$(grep $func doc/starpu.texi | grep deftypefun)
+    if test "$x" == "" ; then
+        echo "Error. Function ${redcolor}${func}${stcolor} is not (or incorrectly) documented"
+    fi
+done
+
+