Bladeren bron

move doxygen doc to .h file

Nathalie Furmento 4 jaren geleden
bovenliggende
commit
cecc40fdde
3 gewijzigde bestanden met toevoegingen van 11 en 29 verwijderingen
  1. 0 1
      doc/doxygen/Makefile.am
  2. 0 28
      doc/doxygen/chapters/api/fpga_extensions.doxy
  3. 11 0
      include/starpu_config.h.in

+ 0 - 1
doc/doxygen/Makefile.am

@@ -106,7 +106,6 @@ chapters =	\
 	chapters/code/disk_compute.c \
 	chapters/code/nf_initexit.f90 \
 	chapters/api/fft_support.doxy \
-	chapters/api/fpga_extensions.doxy \
 	chapters/api/versioning.doxy \
 	chapters/api/threads.doxy
 

+ 0 - 28
doc/doxygen/chapters/api/fpga_extensions.doxy

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

+ 11 - 0
include/starpu_config.h.in

@@ -78,6 +78,12 @@
    @ingroup API_MPI_Support
 */
 #undef STARPU_USE_MPI_MASTER_SLAVE
+
+/**
+   Defined when StarPU has been installed with FPGA support. It should
+   be used in your code to detect the availability of FPGA.
+   @ingroup API_FPGA_Extensions
+*/
 #undef STARPU_USE_FPGA
 
 /**
@@ -217,6 +223,11 @@
  */
 #undef STARPU_MAXCUDADEVS
 
+/**
+   Define the maximum number of FPGA devices that are supported by
+   StarPU.
+   @ingroup API_FPGA_Extensions
+ */
 #undef STARPU_MAXFPGADEVS
 
 /**