Przeglądaj źródła

doc/doxygen: improve doc

Nathalie Furmento 12 lat temu
rodzic
commit
ac237440ab

+ 1 - 0
doc/doxygen/Makefile.am

@@ -158,6 +158,7 @@ $(DOX_PDF): $(DOX_TAG) refman.tex
 	rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
 	sed -i -e 's/__env__/\\_Environment Variables!/' -e 's/\\-\\_\\-\\-\\_\\-env\\-\\_\\-\\-\\_\\-//' ExecutionConfigurationThroughEnvironmentVariables.tex ;\
 	sed -i -e 's/__configure__/\\_Configure Options!/' -e 's/\\-\\_\\-\\-\\_\\-configure\\-\\_\\-\\-\\_\\-//' CompilationConfiguration.tex ;\
+	sed -i s'/\\item Module\\-Documentation/\\item \\hyperlink{ModuleDocumentation}{Module Documentation}/' index.tex ;\
 	$(PDFLATEX) refman.tex; \
 	$(MAKEINDEX) refman.idx;\
 	$(PDFLATEX) refman.tex; \

+ 17 - 0
doc/doxygen/chapters/introduction.doxy

@@ -198,6 +198,8 @@ http://hal.archives-ouvertes.fr/inria-00467677.
 
 The documentation chapters include
 
+<ol>
+<li> Part: Using StarPU
 <ul>
 <li> \ref BuildingAndInstallingStarPU
 <li> \ref BasicExamples
@@ -212,6 +214,21 @@ The documentation chapters include
 <li> \ref SchedulingContexts
 <li> \ref SchedulingContextHypervisor
 </ul>
+</li>
+<li> Part: Inside StarPU
+<ul>
+<li> \ref ExecutionConfigurationThroughEnvironmentVariables
+<li> \ref CompilationConfiguration
+<li> \ref ModuleDocumentation
+<li> \ref deprecated
+</ul>
+<li> Part: Appendix
+<ul>
+<li> \ref FullSourceCodeVectorScal
+<li> \ref GNUFreeDocumentationLicense
+</ul>
+</ol>
+
 
 Make sure to have had a look at those too!
 

+ 4 - 2
doc/doxygen/refman.tex

@@ -92,13 +92,13 @@ Documentation License”.
 \pagenumbering{arabic}
 \hypersetup{pageanchor=true,citecolor=blue}
 
-\part{Using StarPU}
-
 \chapter{Introduction}
 \label{index}
 \hypertarget{index}{}
 \input{index}
 
+\part{Using StarPU}
+
 \chapter{Building and Installing StarPU}
 \label{BuildingAndInstallingStarPU}
 \hypertarget{BuildingAndInstallingStarPU}{}
@@ -175,6 +175,8 @@ Documentation License”.
 \input{modules}
 
 \chapter{Module Documentation a.k.a StarPU's API}
+\label{ModuleDocumentation}
+\hypertarget{ModuleDocumentation}{}
 
 \input{group__API__Versioning}
 \input{group__API__Initialization__and__Termination}