doc: move doc to include/starpu_config.h.in

doc/doxygen/Makefile.am

@@ -96,16 +96,8 @@ chapters =	\
 	chapters/code/disk_copy.c \
 	chapters/code/disk_compute.c \
 	chapters/code/nf_initexit.f90 \
-	chapters/api/codelet_and_tasks.doxy \
 	chapters/api/fft_support.doxy \
-	chapters/api/mpi.doxy \
-	chapters/api/opencl_extensions.doxy \
-	chapters/api/openmp_runtime_support.doxy \
-	chapters/api/mic_extensions.doxy \
-	chapters/api/scheduling_contexts.doxy \
-	chapters/api/scheduling_policy.doxy \
 	chapters/api/versioning.doxy \
-	chapters/api/workers.doxy \
 	chapters/api/threads.doxy
 
 images = 	\

doc/doxygen/chapters/api/codelet_and_tasks.doxy

@@ -1,25 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2020  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
- * 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.
- */
-
-/*! \ingroup API_Codelet_And_Tasks
-
-\def STARPU_NMAXBUFS
-\ingroup API_Codelet_And_Tasks
-Define the maximum number of buffers that tasks will be able to take
-as parameters. The default value is 8, it can be changed by using the
-configure option \ref enable-maxbuffers "--enable-maxbuffers".
-
-*/

doc/doxygen/chapters/api/mic_extensions.doxy

@@ -1,28 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2020  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
- * 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.
- */
-
-/*! \ingroup API_MIC_Extensions
-
-\def STARPU_USE_MIC
-\ingroup API_MIC_Extensions
-Defined when StarPU has been installed with MIC support.
-It should be used in your code to detect the availability of MIC.
-
-\def STARPU_MAXMICDEVS
-\ingroup API_MIC_Extensions
-Define the maximum number of MIC devices that are supported by StarPU.
-
-*/

doc/doxygen/chapters/api/mpi.doxy

@@ -1,34 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2020  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
- * 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.
- */
-
-/*! \ingroup API_MPI_Support MPI Support
-
-\def STARPU_USE_MPI
-\ingroup API_MPI_Support
-Defined when StarPU has been installed with MPI support. It should be
-used in your code to detect the availability of MPI.
-
-@name MPI Master Slave
-\anchor MPIMasterSlaveSupport
-\ingroup API_MPI_Support
-
-\def STARPU_USE_MPI_MASTER_SLAVE
-\ingroup API_MPI_Support
-Defined when StarPU has been installed with MPI Master Slave
-support. It should be used in your code to detect the availability of
-MPI Master Slave.
-
-*/

doc/doxygen/chapters/api/opencl_extensions.doxy

@@ -1,35 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2020  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
- * 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.
- */
-
-/*! \ingroup API_OpenCL_Extensions
-
-\def STARPU_USE_OPENCL
-\ingroup API_OpenCL_Extensions
-Defined when StarPU has been installed with
-OpenCL support. It should be used in your code to detect the
-availability of OpenCL as shown in \ref FullSourceCodeVectorScal.
-
-\def STARPU_MAXOPENCLDEVS
-\ingroup API_OpenCL_Extensions
-Define the maximum number of OpenCL devices that are
-supported by StarPU.
-
-\def STARPU_OPENCL_DATADIR
-\ingroup API_OpenCL_Extensions
-Define the directory in which the OpenCL codelets of the
-applications provided with StarPU have been installed.
-
-*/

doc/doxygen/chapters/api/openmp_runtime_support.doxy

@@ -1,25 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2014-2020  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
- * 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.
- */
-
-/*! \ingroup API_OpenMP_Runtime_Support
-
-\def STARPU_OPENMP
-\ingroup API_OpenMP_Runtime_Support
-This macro is defined when StarPU has been installed with OpenMP Runtime
-support. It should be used in your code to detect the availability of
-the runtime support for OpenMP.
-
-*/

doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -1,25 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2020  Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
- * Copyright (C) 2016       Uppsala University
- *
- * 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.
- */
-
-/*! \ingroup API_Scheduling_Contexts
-
-\def STARPU_NMAX_SCHED_CTXS
-\ingroup API_Scheduling_Policy
-Define the maximum number of scheduling contexts managed by StarPU. The default value can be
-modified at configure by using the option \ref enable-max-sched-ctxs "--enable-max-sched-ctxs".
-
-*/

doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -1,24 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2020  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
- * 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.
- */
-
-/*! \ingroup API_Scheduling_Policy Scheduling Policy
-
-\def STARPU_MAXIMPLEMENTATIONS
-\ingroup API_Scheduling_Policy
-Define the maximum number of implementations per architecture. The default value can be modified at
-configure by using the option \ref enable-maximplementations "--enable-maximplementations".
-
-*/

doc/doxygen/chapters/api/versioning.doxy

@@ -16,18 +16,6 @@
 
 /*! \defgroup API_Versioning Versioning
 
-\def STARPU_MAJOR_VERSION
-\ingroup API_Versioning
-Define the major version of StarPU. This is the version used when compiling the application.
-
-\def STARPU_MINOR_VERSION
-\ingroup API_Versioning
-Define the minor version of StarPU. This is the version used when compiling the application.
-
-\def STARPU_RELEASE_VERSION
-\ingroup API_Versioning
-Define the release version of StarPU. This is the version used when compiling the application.
-
 \fn void starpu_get_version(int *major, int *minor, int *release)
 \ingroup API_Versioning
 Return as 3 integers the version of StarPU used when running the application.

doc/doxygen/chapters/api/workers.doxy

@@ -1,39 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2020  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
- * 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.
- */
-
-/*! \ingroup API_Workers_Properties
-
-\def STARPU_NMAXWORKERS
-\ingroup API_Workers_Properties
-Define the maximum number of workers managed by StarPU.
-
-\def STARPU_MAXCPUS
-\ingroup API_Workers_Properties
-Define the maximum number of CPU workers managed by StarPU. The default value can be modified at
-configure by using the option \ref enable-maxcpus "--enable-maxcpus".
-
-\def STARPU_MAXNUMANODES
-\ingroup API_Workers_Properties
-Define the maximum number of NUMA nodes managed by StarPU. The default value can be modified at
-configure by using the option \ref enable-maxnumanodes "--enable-maxnumanodes".
-
-\def STARPU_MAXNODES
-\ingroup API_Workers_Properties
-Define the maximum number of memory nodes managed by StarPU. The default value can be modified at
-configure by using the option \ref enable-maxnodes "--enable-maxnodes". Reducing it allows to
-considerably reduce memory used by StarPU data structures.
-
-*/

include/starpu_config.h.in

@@ -25,17 +25,68 @@
 #ifndef __STARPU_CONFIG_PUBLIC_H__
 #define __STARPU_CONFIG_PUBLIC_H__
 
+/**
+   Define the major version of StarPU. This is the version used when
+   compiling the application.
+   @ingroup API_Versioning
+*/
 #undef STARPU_MAJOR_VERSION
+
+/**
+   @ingroup API_Versioning
+   Define the minor version of StarPU. This is the version used when
+   compiling the application.
+*/
 #undef STARPU_MINOR_VERSION
+
+/**
+   Define the release version of StarPU. This is the version used when
+   compiling the application.
+   @ingroup API_Versioning
+*/
 #undef STARPU_RELEASE_VERSION
 
 #undef STARPU_USE_CPU
+
+/**
+   Defined when StarPU has been installed with
+   CUDA support. It should be used in your code to detect the
+   availability of CUDA.
+   @ingroup API_CUDA_Extensions
+*/
 #undef STARPU_USE_CUDA
+
+/**
+   Defined when StarPU has been installed with OpenCL support. It
+   should be used in your code to detect the availability of OpenCL as
+   shown in \ref FullSourceCodeVectorScal.
+   @ingroup API_OpenCL_Extensions
+*/
 #undef STARPU_USE_OPENCL
+
+/**
+   Defined when StarPU has been installed with MIC support. It should
+   be used in your code to detect the availability of MIC.
+   @ingroup API_MIC_Extensions
+*/
 #undef STARPU_USE_MIC
+
+/**
+   Defined when StarPU has been installed with MPI Master Slave
+   support. It should be used in your code to detect the availability
+   of MPI Master Slave.
+   @ingroup API_MPI_Support
+*/
 #undef STARPU_USE_MPI_MASTER_SLAVE
 
+/**
+   Defined when StarPU has been installed with OpenMP Runtime support.
+   It should be used in your code to detect the availability of the
+   runtime support for OpenMP.
+   @ingroup API_OpenMP_Runtime_Support
+*/
 #undef STARPU_OPENMP
+
 #undef STARPU_CLUSTER
 
 #undef STARPU_SIMGRID
@@ -57,9 +108,13 @@
 /* workers must call callbacks on sleep/wake-up */
 #undef STARPU_WORKER_CALLBACKS
 
-
 #undef STARPU_HAVE_ICC
 
+/**
+   Defined when StarPU has been installed with MPI support. It should
+   be used in your code to detect the availability of MPI.
+   @ingroup API_MPI_Support
+*/
 #undef STARPU_USE_MPI
 #undef STARPU_USE_MPI_MPI
 #undef STARPU_USE_MPI_NMAD
@@ -72,6 +127,11 @@
 #undef STARPU_SYSTEM_BLAS
 #undef STARPU_HAVE_CBLAS_H
 
+/**
+   Define the directory in which the OpenCL codelets of the
+   applications provided with StarPU have been installed.
+   @ingroup API_OpenCL_Extensions
+*/
 #undef STARPU_OPENCL_DATADIR
 #undef STARPU_HAVE_MAGMA
 
@@ -107,16 +167,82 @@
 
 #undef STARPU_HAVE_CURAND
 
+/**
+   Define the maximum number of memory nodes managed by StarPU. The
+   default value can be modified at configure by using the option \ref
+   enable-maxnodes "--enable-maxnodes". Reducing it allows to
+   considerably reduce memory used by StarPU data structures.
+   @ingroup API_Workers_Properties
+*/
 #undef STARPU_MAXNODES
+
+/**
+   Define the maximum number of buffers that tasks will be able to
+   take as parameters. The default value is 8, it can be changed by
+   using the configure option \ref enable-maxbuffers
+   "--enable-maxbuffers".
+   @ingroup API_Codelet_And_Tasks
+*/
 #undef STARPU_NMAXBUFS
+
+/**
+   Define the maximum number of CPU workers managed by StarPU. The
+   default value can be modified at configure by using the option \ref
+   enable-maxcpus "--enable-maxcpus".
+   @ingroup API_Workers_Properties
+*/
 #undef STARPU_MAXCPUS
+
+/**
+   Define the maximum number of NUMA nodes managed by StarPU. The
+   default value can be modified at configure by using the option \ref
+   enable-maxnumanodes "--enable-maxnumanodes".
+   @ingroup API_Workers_Properties
+*/
 #undef STARPU_MAXNUMANODES
+
+/**
+ * Define the maximum number of CUDA devices that are supported by StarPU.
+ * @ingroup API_CUDA_Extensions
+ */
 #undef STARPU_MAXCUDADEVS
+
+/**
+   Define the maximum number of OpenCL devices that are supported by
+   StarPU.
+   @ingroup API_OpenCL_Extensions
+*/
 #undef STARPU_MAXOPENCLDEVS
+
+/**
+   Define the maximum number of MIC devices that are supported by
+   StarPU.
+   @ingroup API_MIC_Extensions
+*/
 #undef STARPU_MAXMICDEVS
+
+/**
+   Define the maximum number of workers managed by StarPU.
+   @ingroup API_Workers_Properties
+*/
 #undef STARPU_NMAXWORKERS
+
+/**
+   Define the maximum number of scheduling contexts managed by StarPU.
+   The default value can be modified at configure by using the option
+   \ref enable-max-sched-ctxs "--enable-max-sched-ctxs".
+   @ingroup API_Scheduling_Policy
+*/
 #undef STARPU_NMAX_SCHED_CTXS
+
+/**
+   Define the maximum number of implementations per architecture. The
+   default value can be modified at configure by using the option \ref
+   enable-maximplementations "--enable-maximplementations".
+   @ingroup API_Scheduling_Policy
+*/
 #undef STARPU_MAXIMPLEMENTATIONS
+
 #undef STARPU_MAXMPKERNELS
 #undef STARPU_USE_SC_HYPERVISOR
 #undef STARPU_SC_HYPERVISOR_DEBUG