doc: small fixes

starpu-runtime · Mar 13, 2024 · 0828cf9 · 0828cf9
1 parent ecb87bc
commit 0828cf9
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 21 deletions.
diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
@@ -44,11 +44,11 @@ chapters =	\
 	chapters/starpu_basics/data_management.doxy		\
 	chapters/starpu_basics/scheduling.doxy		\
 	chapters/starpu_basics/examples_sources.doxy		\
-	chapters/starpu_basics/code/vector_scal_c.c \
-	chapters/starpu_basics/code/vector_scal_cpu.c \
-	chapters/starpu_basics/code/vector_scal_cuda.c \
-	chapters/starpu_basics/code/vector_scal_opencl.c \
-	chapters/starpu_basics/code/vector_scal_opencl_codelet.cl \
+	chapters/starpu_basics/code/basics_vector_scal_c.c \
+	chapters/starpu_basics/code/basics_vector_scal_cpu.c \
+	chapters/starpu_basics/code/basics_vector_scal_cuda.c \
+	chapters/starpu_basics/code/basics_vector_scal_opencl.c \
+	chapters/starpu_basics/code/basics_vector_scal_opencl_codelet.cl \
 	chapters/starpu_applications/applications_intro.doxy		\
 	chapters/starpu_applications/vector_scaling.doxy		\
 	chapters/starpu_applications/code/vector_scal_c.c		\

diff --git a/doc/doxygen/chapters/starpu_basics/basic_examples.doxy b/doc/doxygen/chapters/starpu_basics/basic_examples.doxy
@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009-2023  Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
+ * Copyright (C) 2009-2024  Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
  *
  * 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
@@ -407,7 +407,7 @@ that the vector pointer returned by ::STARPU_VECTOR_GET_PTR is here a
 pointer in GPU memory, so that it can be passed as such to the
 kernel call <c>vector_mult_cuda</c>.
 
-\snippet vector_scal_cuda.c To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_cuda.c To be included. You should update doxygen if you see this text.
 
 \subsection DefinitionOfTheOpenCLKernel Definition of the OpenCL Kernel
 
@@ -430,7 +430,7 @@ which returns a <c>cl_mem</c> (which is not a device pointer, but an OpenCL
 handle), which can be passed as such to the OpenCL kernel. The difference is
 important when using partitioning, see \ref PartitioningData.
 
-\snippet vector_scal_opencl.c To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_opencl.c To be included. You should update doxygen if you see this text.
 
 \subsection DefinitionOfTheMainCode Definition of the Main Code
 
@@ -441,7 +441,7 @@ starpu_codelet::cuda_funcs and starpu_codelet::opencl_funcs are set to
 define the pointers to the CUDA and OpenCL implementations of the
 task.
 
-\snippet vector_scal_c.c To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_c.c To be included. You should update doxygen if you see this text.
 
 \subsection ExecutionOfHybridVectorScaling Execution of Hybrid Vector Scaling
 

diff --git a/...apters/starpu_basics/code/vector_scal_c.c → ...starpu_basics/code/basics_vector_scal_c.c b/...apters/starpu_basics/code/vector_scal_c.c → ...starpu_basics/code/basics_vector_scal_c.c
diff --git a/...ters/starpu_basics/code/vector_scal_cpu.c → ...arpu_basics/code/basics_vector_scal_cpu.c b/...ters/starpu_basics/code/vector_scal_cpu.c → ...arpu_basics/code/basics_vector_scal_cpu.c
diff --git a/...ers/starpu_basics/code/vector_scal_cuda.c → ...rpu_basics/code/basics_vector_scal_cuda.c b/...ers/starpu_basics/code/vector_scal_cuda.c → ...rpu_basics/code/basics_vector_scal_cuda.c
diff --git a/...s/starpu_basics/code/vector_scal_opencl.c → ...u_basics/code/basics_vector_scal_opencl.c b/...s/starpu_basics/code/vector_scal_opencl.c → ...u_basics/code/basics_vector_scal_opencl.c
diff --git a/...basics/code/vector_scal_opencl_codelet.cl → ...code/basics_vector_scal_opencl_codelet.cl b/...basics/code/vector_scal_opencl_codelet.cl → ...code/basics_vector_scal_opencl_codelet.cl
diff --git a/doc/doxygen/chapters/starpu_basics/scaling_vector_example.doxy b/doc/doxygen/chapters/starpu_basics/scaling_vector_example.doxy
@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2009-2021  Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
+ * Copyright (C) 2009-2021, 2024  Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
  *
  * 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
@@ -18,25 +18,25 @@
 
 \section MainApplication Main Application
 
-\snippet vector_scal_c.c To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_c.c To be included. You should update doxygen if you see this text.
 
 \section CPUKernel CPU Kernel
 
-\snippet vector_scal_cpu.c To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_cpu.c To be included. You should update doxygen if you see this text.
 
 \section CUDAKernel CUDA Kernel
 
-\snippet vector_scal_cuda.c To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_cuda.c To be included. You should update doxygen if you see this text.
 
 \section OpenCLKernel OpenCL Kernel
 
 \subsection InvokingtheKernel Invoking the Kernel
 
-\snippet vector_scal_opencl.c To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_opencl.c To be included. You should update doxygen if you see this text.
 
 \subsection SourceoftheKernel Source of the Kernel
 
-\snippet vector_scal_opencl_codelet.cl To be included. You should update doxygen if you see this text.
+\snippet basics_vector_scal_opencl_codelet.cl To be included. You should update doxygen if you see this text.
 
 */
 
diff --git a/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy b/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy
@@ -19,6 +19,8 @@
 \foreword
 \webforeword
 
+
+# we need to keep 2 blank lines above
 \section Motivation Motivation
 
 // This is a comment and it will be removed before the file is processed by doxygen

diff --git a/doc/doxygen_web_basics/Makefile.am b/doc/doxygen_web_basics/Makefile.am
@@ -36,11 +36,11 @@ chapters =	\
 	../doxygen/chapters/starpu_basics/data_management.doxy		\
 	../doxygen/chapters/starpu_basics/scheduling.doxy		\
 	../doxygen/chapters/starpu_basics/examples_sources.doxy		\
-	../doxygen/chapters/starpu_basics/code/vector_scal_c.c \
-	../doxygen/chapters/starpu_basics/code/vector_scal_cpu.c \
-	../doxygen/chapters/starpu_basics/code/vector_scal_cuda.c \
-	../doxygen/chapters/starpu_basics/code/vector_scal_opencl.c \
-	../doxygen/chapters/starpu_basics/code/vector_scal_opencl_codelet.cl \
+	../doxygen/chapters/starpu_basics/code/basics_vector_scal_c.c \
+	../doxygen/chapters/starpu_basics/code/basics_vector_scal_cpu.c \
+	../doxygen/chapters/starpu_basics/code/basics_vector_scal_cuda.c \
+	../doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl.c \
+	../doxygen/chapters/starpu_basics/code/basics_vector_scal_opencl_codelet.cl \
 	../doxygen/chapters/files.doxy		\
 	../doxygen/chapters/fdl_1_3.doxy
 

diff --git a/doc/doxygen_web_basics/doxygen-config.cfg.in b/doc/doxygen_web_basics/doxygen-config.cfg.in
@@ -28,7 +28,8 @@ INPUT                  = @top_srcdir@/doc/doxygen/chapters/starpu_basics/basics_
                       @top_srcdir@/doc/doxygen/chapters/api
 
 EXAMPLE_PATH           = @top_srcdir@/doc/doxygen \
-                         @top_srcdir@/doc/doxygen/chapters
+                         @top_srcdir@/doc/doxygen/chapters \
+			 @top_srcdir@/doc/doxygen/chapters/starpu_basics/code
 
 INPUT_FILTER           = @top_builddir@/doc/doxygen/doxygen_filter.sh