doxygen update

doc/doxygen/Makefile.am

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

doc/doxygen/chapters/api/versioning.doxy

@@ -1,24 +0,0 @@
-/* StarPU --- Runtime system for heterogeneous multicore architectures.
- *
- * Copyright (C) 2009-2021  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.
- */
-
-/*! \defgroup API_Versioning Versioning
-
-\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.
-
-*/
-

include/starpu.h

@@ -569,8 +569,23 @@ int starpu_asynchronous_opencl_copy_disabled(void);
 */
 int starpu_asynchronous_mpi_ms_copy_disabled(void);
 
+/**
+   Call starpu_profiling_bus_helper_display_summary() and
+   starpu_profiling_worker_helper_display_summary()
+ */
 void starpu_display_stats(void);
 
+/** @} */
+
+/**
+   @defgroup API_Versioning Versioning
+   @{
+*/
+
+/**
+   Return as 3 integers the version of StarPU used when running the
+   application.
+*/
 void starpu_get_version(int *major, int *minor, int *release);
 
 /** @} */

include/starpu_clusters.h

@@ -35,71 +35,71 @@ extern "C"
  */
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_MIN_NB			(1<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_MAX_NB			(2<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_NB			(3<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_PREFERE_MIN		(4<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_KEEP_HOMOGENEOUS		(5<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_POLICY_NAME		(6<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_POLICY_STRUCT		(7<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_CREATE_FUNC		(8<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_CREATE_FUNC_ARG		(9<<STARPU_MODE_SHIFT)
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_TYPE			(10<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_AWAKE_WORKERS		(11<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_PARTITION_ONE		(12<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_NEW			(13<<STARPU_MODE_SHIFT)
 
 /**
-   Used when calling starpu_cluster_machine
+   Used when calling starpu_cluster_machine()
  */
 #define STARPU_CLUSTER_NCORES			(14<<STARPU_MODE_SHIFT)
 

include/starpu_data.h

@@ -110,14 +110,14 @@ enum starpu_data_access_mode
 				   src/sched_policies/work_stealing_policy.c
 				   source code.
 				*/
-	STARPU_MPI_REDUX=(1<<7), /** Inter-node reduction only. Codelets 
+	STARPU_MPI_REDUX=(1<<7), /**< Inter-node reduction only. Codelets
 				    contributing to these reductions should
-				    be registered with STARPU_RW | STARPU_COMMUTE 
+				    be registered with ::STARPU_RW | ::STARPU_COMMUTE
 				    access modes.
 			            When inserting these tasks through the
 				    MPI layer however, the access mode needs
-				    to be STARPU_MPI_REDUX. */
-	STARPU_ACCESS_MODE_MAX=(1<<8) /** The purpose of ACCESS_MODE_MAX is to
+				    to be ::STARPU_MPI_REDUX. */
+	STARPU_ACCESS_MODE_MAX=(1<<8) /**< The purpose of ::STARPU_ACCESS_MODE_MAX is to
 					be the maximum of this enum. */
 };
 

include/starpu_task.h

@@ -1360,6 +1360,13 @@ struct starpu_task
    SettingManyDataHandlesForATask)
 */
 #define STARPU_TASK_GET_HANDLE(task, i) (((task)->dyn_handles) ? (task)->dyn_handles[i] : (task)->handles[i])
+
+/**
+   Return all the data handles of \p task. If \p task is defined
+   with a static or dynamic number of handles, will either return all
+   the element of the field starpu_task::handles or all the elements
+   of the field starpu_task::dyn_handles (see \ref SettingManyDataHandlesForATask)
+*/
 #define STARPU_TASK_GET_HANDLES(task) (((task)->dyn_handles) ? (task)->dyn_handles : (task)->handles)
 
 /**

include/starpu_task_util.h

@@ -526,14 +526,13 @@ void starpu_codelet_pack_arg_fini(struct starpu_codelet_pack_arg_data *state, vo
 void starpu_codelet_unpack_args(void *cl_arg, ...);
 
 /**
-   Initialize struct starpu_codelet_pack_arg_data before calling
-   starpu_codelet_unpack_arg(). This will pass the starpu_task->cl_arg 
-   and starpu_task->cl_arg_size to the content of struct starpu_codelet_pack_arg_data.
+   Initialize \p state before calling starpu_codelet_unpack_arg().
+   This will pass \p cl_arg and \p cl_arg_size the content of struct starpu_codelet_pack_arg_data.
 */
 void starpu_codelet_unpack_arg_init(struct starpu_codelet_pack_arg_data *state, void **cl_arg, size_t *cl_arg_size);
 
 /**
-   Unpack one argument from struct starpu_codelet_pack_arg \p state into ptr with a copy. 
+   Unpack one argument from struct starpu_codelet_pack_arg \p state into ptr with a copy.
    That structure has to be initialized before with starpu_codelet_unpack_arg_init().
    Size is stored in starpu_task->cl_arg, and it is a known parameter in this function .
 */
@@ -541,19 +540,20 @@ void starpu_codelet_unpack_arg(struct starpu_codelet_pack_arg_data *state, void
 
 /**
    Unpack one argument from struct starpu_codelet_pack_arg \p state into ptr with a copy.
-   That structure has to be initialized before with starpu_codelet_unpack_arg_init(). 
-   Size is stored in starpu_task->cl_arg, and it is an unknown parameter in this function. 
+   That structure has to be initialized before with starpu_codelet_unpack_arg_init().
+   Size is stored in starpu_task->cl_arg, and it is an unknown parameter in this function.
    It will be returned from starpu_task->cl_arg with a copy.
 */
 void starpu_codelet_dup_arg(struct starpu_codelet_pack_arg_data *state, void **ptr, size_t *size);
 
 /**
-   Unpack one argument from struct starpu_codelet_pack_arg \p state into ptr, and the pointer of ptr will be returned.
-   That structure has to be initialized before with starpu_codelet_unpack_arg_init(). 
-   Size is stored in starpu_task->cl_arg, and it is an unknown parameter in this function. 
+   Unpack one argument from struct starpu_codelet_pack_arg \p state
+   into ptr, and the pointer of ptr will be returned.
+   That structure has to be initialized before with starpu_codelet_unpack_arg_init().
+   Size is stored in starpu_task->cl_arg, and it is an unknown parameter in this function.
    It will be returned from starpu_task->cl_arg with a copy.
 */
-void starpu_codelet_pick_arg(struct starpu_codelet_pack_arg_data *state, void **ptr, size_t *size); 
+void starpu_codelet_pick_arg(struct starpu_codelet_pack_arg_data *state, void **ptr, size_t *size);
 
 void starpu_codelet_unpack_arg_fini(struct starpu_codelet_pack_arg_data *state);