Przeglądaj źródła

doc/doxygen: update configuration

Nathalie Furmento 12 lat temu
rodzic
commit
9eb6f39f2f
1 zmienionych plików z 39 dodań i 38 usunięć
  1. 39 38
      doc/doxygen/Doxyfile.handbook

+ 39 - 38
doc/doxygen/Doxyfile.handbook

@@ -1,3 +1,21 @@
+# 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.
+
 # Doxyfile 1.8.3.1
 
 # This file describes the settings to be used by the documentation system
@@ -10,6 +28,12 @@
 #       TAG += value [value, ...]
 # Values that contain spaces should be placed between quotes (" ").
 
+# We include a file here that is generated by StarPU's configure
+# script.  This file will contain some configure-set values, such as
+# version, source dir, etc.
+
+@INCLUDE = doxygen-config.cfg
+
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
@@ -250,7 +274,7 @@ EXTENSION_MAPPING      =
 # can mix doxygen, HTML, and XML commands with Markdown formatting.
 # Disable only in case of backward compatibilities issues.
 
-MARKDOWN_SUPPORT       = YES
+MARKDOWN_SUPPORT       = NO
 
 # When enabled doxygen tries to link words that correspond to documented classes,
 # or namespaces to their corresponding documentation. Such a link can be
@@ -668,40 +692,13 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = chapters/introduction.doxy \
-                         chapters/building.doxy \
-                         chapters/basic_examples.doxy \
-                         chapters/advanced_examples.doxy \
-                         chapters/optimize_performance.doxy \
-                         chapters/performance_feedback.doxy \
-                         chapters/tips_and_tricks.doxy \
-                         chapters/mpi_support.doxy \
-                         chapters/fft_support.doxy \
-                         chapters/c_extensions.doxy \
-                         chapters/socl_opencl_extensions.doxy \
-                         chapters/scheduling_contexts.doxy \
-                         chapters/scheduling_context_hypervisor.doxy \
-                         chapters/api/initialization.doxy \
-                         chapters/api/versioning.doxy \
-                         chapters/api/standard_memory_library.doxy \
-                         chapters/api/workers.doxy \
-                         chapters/api/data_management.doxy \
-                         chapters/api/data_interfaces.doxy \
-                         chapters/api/data_partition.doxy \
-                         chapters/api/multiformat_data_interface.doxy \
-                         chapters/api/codelet_and_tasks.doxy \
-                         chapters/api/insert_task.doxy \
+INPUT                  = chapters \
+		       	 chapters/api \
                          ../../build/include/starpu_config.h \
-                         ../../include/starpu.h \
-                         ../../include/starpu_driver.h \
-                         ../../include/starpu_stdlib.h \
-                         ../../include/starpu_worker.h \
-                         ../../include/starpu_data.h \
-                         ../../include/starpu_data_interfaces.h \
-                         ../../include/starpu_data_filters.h \
-                         ../../include/starpu_hash.h \
-                         ../../include/starpu_task.h \
-                         ../../include/starpu_task_util.h
+                         ../../include/ \
+			 ../../mpi/include/ \
+			 ../../starpufft/starpufft.h \
+			 ../../sc_hypervisor/include
 
 # 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
@@ -719,7 +716,7 @@ INPUT_ENCODING         = UTF-8
 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
 # *.f90 *.f *.for *.vhd *.vhdl
 
-FILE_PATTERNS          =
+FILE_PATTERNS          = *.h *.doxy
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 # should be searched for input files as well. Possible values are YES and NO.
@@ -761,7 +758,7 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = /home/nfurmento/softs/starpu/soft/starpu.git/doc/doxygen/chapters
 
 # 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
@@ -792,7 +789,7 @@ IMAGE_PATH             =
 # If FILTER_PATTERNS is specified, this tag will be
 # ignored.
 
-INPUT_FILTER           = "sed 's,STARPU_DEPRECATED,,'"
+INPUT_FILTER           = ./starpu_doxygen_filter.sh
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis.
@@ -1370,7 +1367,7 @@ 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
+LATEX_HEADER           = chapters/refman.tex
 
 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
 # the generated latex document. The footer should contain everything after
@@ -1621,6 +1618,10 @@ INCLUDE_FILE_PATTERNS  =
 
 PREDEFINED             = STARPU_USE_OPENCL=1 \
                          STARPU_USE_CUDA=1 \
+                         STARPU_USE_MIC=1 \
+			 STARPU_USE_MPI=1 \
+			 STARPU_HAVE_HWLOC=1 \
+			 STARPU_USE_SC_HYPERVISOR=1 \
                          __GCC__
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then