Browse Source

doc/doxygen/doxygen_filter.sh.in: comments to explain what is removed from the doxygen input files

Nathalie Furmento 11 years ago
parent
commit
55aeb0cc4d
1 changed files with 2 additions and 0 deletions
  1. 2 0
      doc/doxygen/doxygen_filter.sh.in

+ 2 - 0
doc/doxygen/doxygen_filter.sh.in

@@ -3,6 +3,8 @@
 if [ "$(basename $1)" == "starpufft.h" ] ; then
 if [ "$(basename $1)" == "starpufft.h" ] ; then
     gcc -E $1 -I @top_srcdir@/include/ -I @top_builddir@/include/ |grep starpufft
     gcc -E $1 -I @top_srcdir@/include/ -I @top_builddir@/include/ |grep starpufft
 else
 else
+    # the macro STARPU_DEPRECATED needs to be removed as it is properly processed by doxygen
+    # lines starting with // in the doxygen input files are considered as comments to be removed
     sed -e 's/STARPU_DEPRECATED//' $1 | sed 's/\/\/.*//'
     sed -e 's/STARPU_DEPRECATED//' $1 | sed 's/\/\/.*//'
 fi
 fi