Forráskód Böngészése

doc/doxygen: update generation

Nathalie Furmento 12 éve
szülő
commit
08e29bc0fa

+ 4 - 0
configure.ac

@@ -2166,6 +2166,7 @@ AC_CONFIG_COMMANDS([executable-scripts], [
   chmod +x tools/starpu_codelet_profile
   chmod +x tools/starpu_codelet_histo_profile
   chmod +x tools/starpu_workers_activity
+  chmod +x doc/doxygen/starpu_doxygen_filter.sh
 ])
 
 # Create links to ICD files in build/socl/vendors directory. SOCL will use this
@@ -2225,6 +2226,9 @@ AC_OUTPUT([
 	sc_hypervisor/Makefile
 	sc_hypervisor/src/Makefile
 	sc_hypervisor/examples/Makefile
+	doc/doxygen/Makefile
+	doc/doxygen/doxygen-config.cfg
+	doc/doxygen/starpu_doxygen_filter.sh
 ])
 
 AC_MSG_NOTICE([

+ 31 - 0
doc/doxygen/doxygen-config.cfg.in

@@ -0,0 +1,31 @@
+# StarPU --- Runtime system for heterogeneous multicore architectures.
+#
+# Copyright (C) 2009-2013  Université de Bordeaux 1
+# Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
+# Copyright (C) 2011  Télécom-SudParis
+# Copyright (C) 2011, 2012  Institut National de Recherche en Informatique et Automatique
+#
+# StarPU is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or (at
+# your option) any later version.
+#
+# StarPU is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# See the GNU Lesser General Public License in COPYING.LGPL for more details.
+
+INPUT                  = @top_srcdir@/doc/doxygen/chapters \
+		       	 @top_srcdir@/doc/doxygen/chapters/api \
+                         @top_builddir@/include/starpu_config.h \
+			 @top_srcdir@/include/ \
+			 @top_srcdir@/mpi/include/ \
+			 @top_srcdir@/starpufft/starpufft.h \
+			 @top_srcdir@/sc_hypervisor/include
+
+EXAMPLE_PATH           = @top_srcdir@/doc/doxygen/chapters
+
+INPUT_FILTER           = @top_builddir@/doc/doxygen/starpu_doxygen_filter.sh
+
+LATEX_HEADER           = @top_srcdir@/doc/doxygen/refman.tex

+ 8 - 10
doc/doxygen/doxygen.cfg

@@ -692,13 +692,8 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = chapters \
-		       	 chapters/api \
-                         ../../build/include/starpu_config.h \
-                         ../../include/ \
-			 ../../mpi/include/ \
-			 ../../starpufft/starpufft.h \
-			 ../../sc_hypervisor/include
+#defined in doxygen-config.cfg
+#INPUT                  =
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -758,7 +753,8 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           = /home/nfurmento/softs/starpu/soft/starpu.git/doc/doxygen/chapters
+#defined in doxygen-config.cfg
+#EXAMPLE_PATH
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -789,7 +785,8 @@ IMAGE_PATH             =
 # If FILTER_PATTERNS is specified, this tag will be
 # ignored.
 
-INPUT_FILTER           = ./starpu_doxygen_filter.sh
+#defined in doxygen-config.cfg.in
+#INPUT_FILTER
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis.
@@ -1367,7 +1364,8 @@ EXTRA_PACKAGES         =
 # the first chapter. If it is left blank doxygen will generate a
 # standard header. Notice: only use this tag if you know what you are doing!
 
-LATEX_HEADER           = chapters/refman.tex
+#defined in doxygen-config.cfg
+#LATEX_HEADER
 
 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
 # the generated latex document. The footer should contain everything after

doc/doxygen/refman.tex.in → doc/doxygen/refman.tex


+ 8 - 0
doc/doxygen/starpu_doxygen_filter.sh.in

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+if [ "$(basename $1)" == "starpufft.h" ] ; then
+    gcc -E $1 -I @top_srcdir@/include/ -I @top_builddir@/include/ |grep starpufft
+else
+    sed -e 's/STARPU_DEPRECATED//' $1
+fi
+