Procházet zdrojové kódy

doc: update internal documentation

Nathalie Furmento před 6 roky
rodič
revize
d8bd070143

+ 1 - 3
doc/doxygen_dev/Makefile.am

@@ -114,8 +114,6 @@ $(DOX_TAG): $(dox_inputs)
 	@$(DOXYGEN) $(DOX_CONFIG)
 	@$(SED) -i 's/ModuleDocumentation <\/li>/<a class="el" href="modules.html">Modules<\/a>/' html/index.html
 	@$(SED) -i 's/FileDocumentation <\/li>/<a class="el" href="files.html">Files<\/a>/' html/index.html
-
-old:
         # comment for the line below: what we really want to do is to remove the line, but dy doing so, it avoids opening the interactive menu when browsing files
 	@if test -f html/navtree.js ; then $(SED) -i 's/\[ "Files", "Files.html", null \]/\[ "", "Files.html", null \]/' html/navtree.js ; fi
 	@$(SED) -i 's/.*"Files.html".*//' html/pages.html
@@ -123,7 +121,7 @@ old:
 	@$(SED) -i '/\\begin{titlepage}/,$$d' $(DOX_LATEX_DIR)/refman.tex
 	@cat $(top_srcdir)/doc/doxygen_dev/refman.tex >> $(DOX_LATEX_DIR)/refman.tex
 
-$(DOX_PDF): $(DOX_TAG) #refman.tex
+$(DOX_PDF): $(DOX_TAG) refman.tex
 	@cp $(top_srcdir)/doc/doxygen_dev/chapters/version.sty $(DOX_LATEX_DIR)
 	@-cp $(top_srcdir)/doc/doxygen_dev/chapters/images/*pdf $(DOX_LATEX_DIR)
 	@echo $(PDFLATEX) $(DOX_LATEX_DIR)/refman.tex

+ 2 - 2
doc/doxygen_dev/doxygen.cfg

@@ -1,6 +1,6 @@
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
-# Copyright (C) 2010-2015,2017                           CNRS
+# Copyright (C) 2010-2015,2017,2018                      CNRS
 # Copyright (C) 2009-2014                                Université de Bordeaux
 # Copyright (C) 2011                                     Télécom-SudParis
 # Copyright (C) 2011-2012                                Inria
@@ -50,7 +50,7 @@ DOXYFILE_ENCODING      = UTF-8
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
-PROJECT_NAME           = "StarPU Handbook"
+PROJECT_NAME           = "StarPU Internal Handbook"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or

+ 4 - 2
doc/doxygen_dev/doxygen_filter.sh.in

@@ -1,7 +1,7 @@
 #!/bin/bash
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
-# Copyright (C) 2013-2014,2016-2017                      CNRS
+# Copyright (C) 2013-2014,2016-2018                      CNRS
 #
 # 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
@@ -19,6 +19,8 @@ if [ "$(basename $1)" == "starpufft.h" ] ; then
 else
     # the macro STARPU_DEPRECATED needs to be removed as it is not 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/^\/\/.*//'
+    # replace LIST_TYPE foo by struct foo so that doxygen processes it correctly
+    # we assume lines only containing ); are ending of the definition of such a struct
+    sed -e 's/STARPU_DEPRECATED//' $1 | sed 's/^\/\/.*//' | sed 's/LIST_TYPE(\(.*\),/struct \1 {/' | sed 's/^);/};/'
 fi