소스 검색

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

Nathalie Furmento 11 년 전
부모
커밋
55aeb0cc4d
1개의 변경된 파일2개의 추가작업 그리고 0개의 파일을 삭제
  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
     gcc -E $1 -I @top_srcdir@/include/ -I @top_builddir@/include/ |grep starpufft
 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/\/\/.*//'
 fi