doc/doxygen/chapters: update format

doc/doxygen/chapters/api/codelet_and_tasks.doxy

@@ -12,7 +12,7 @@
 
 \enum starpu_codelet_type
 \ingroup API_Codelet_And_Tasks
-\brief Describes the type of parallel task. See \ref Parallel_Tasks for details.
+Describes the type of parallel task. See \ref Parallel_Tasks for details.
 \var starpu_codelet_type::STARPU_SEQ
 \ingroup API_Codelet_And_Tasks
 (default) for classical sequential tasks.
@@ -29,7 +29,7 @@ many threads should be started.
 
 \enum starpu_task_status
 \ingroup API_Codelet_And_Tasks
-\brief Task status
+Task status
 \var starpu_task_status::STARPU_TASK_INVALID
 \ingroup API_Codelet_And_Tasks
 The task has just been initialized.
@@ -117,7 +117,7 @@ MIC implementation of a codelet.
 SCC implementation of a codelet.
 
 \struct starpu_codelet
-\brief The codelet structure describes a kernel that is possibly
+The codelet structure describes a kernel that is possibly
 implemented on various targets. For compatibility, make sure to
 initialize the whole structure to zero, either by using explicit
 memset, or the function starpu_codelet_init(), or by letting the
@@ -257,8 +257,7 @@ possible, e.g. when using C++.
 
 \struct starpu_data_descr
 \ingroup API_Codelet_And_Tasks
-\brief This type is used to describe a data handle along with an
-access mode.
+This type is used to describe a data handle along with an access mode.
 \var starpu_data_descr::handle
 describes a data
 \var starpu_data_descr::mode
@@ -266,7 +265,7 @@ describes its access mode
 
 \struct starpu_task
 \ingroup API_Codelet_And_Tasks
-\brief The structure describes a task that can be offloaded on the
+The structure describes a task that can be offloaded on the
 various processing units managed by StarPU. It instantiates a codelet.
 It can either be allocated dynamically with the function
 starpu_task_create(), or declared statically. In the latter case, the

doc/doxygen/chapters/api/data_interfaces.doxy

@@ -9,7 +9,7 @@
 /*! \defgroup API_Data_Interfaces Data Interfaces
 
 \struct starpu_data_interface_ops
-\brief Per-interface data transfer methods.
+Per-interface data transfer methods.
 \ingroup API_Data_Interfaces
 \var starpu_data_interface_ops::register_data_handle
 Register an existing interface into a data handle.
@@ -48,9 +48,7 @@ Unpack the data handle from the contiguous buffer at the address ptr
 of size count
 
 \struct starpu_data_copy_methods
-\brief Defines the per-interface methods.
-
-If the any_to_any method is
+Defines the per-interface methods. If the any_to_any method is
 provided, it will be used by default if no more specific method is
 provided. It can still be useful to provide more specific method in
 case of e.g. available particular CUDA or OpenCL support.
@@ -292,7 +290,7 @@ after calling the data unpacking operation.
 \ingroup API_Data_Interfaces
 
 \struct starpu_variable_interface
-\brief Variable interface for a single data (not a vector, a matrix, a list, ...)
+Variable interface for a single data (not a vector, a matrix, a list, ...)
 \ingroup API_Data_Interfaces
 \var starpu_variable_interface::id
 Identifier of the interface
@@ -336,7 +334,7 @@ be used with the device handle.
 \ingroup API_Data_Interfaces
 
 \struct starpu_vector_interface
-\brief Vector interface
+Vector interface
 \ingroup API_Data_Interfaces
 \var starpu_vector_interface::id
 Identifier of the interface
@@ -394,7 +392,7 @@ Return the size of each element of the array designated by
 \ingroup API_Data_Interfaces
 
 \struct starpu_matrix_interface
-\brief Matrix interface for dense matrices
+Matrix interface for dense matrices
 \ingroup API_Data_Interfaces
 \var starpu_matrix_interface::id
 Identifier of the interface
@@ -479,7 +477,7 @@ designated by \p interface.
 \ingroup API_Data_Interfaces
 
 \struct starpu_block_interface
-\brief Block interface for 3D dense blocks
+Block interface for 3D dense blocks
 \ingroup API_Data_Interfaces
 \struct starpu_block_interface::id
 identifier of the interface
@@ -586,7 +584,7 @@ Return the size of the elements of the block designated by
 \ingroup API_Data_Interfaces
 
 \struct starpu_bcsr_interface
-\brief BCSR interface for sparse matrices (blocked compressed sparse
+BCSR interface for sparse matrices (blocked compressed sparse
 row representation)
 \ingroup API_Data_Interfaces
 \var starpu_bcsr_interface::id
@@ -700,7 +698,7 @@ matrix designated by \p interface, to be used with the device handles.
 \ingroup API_Data_Interfaces
 
 \struct starpu_csr_interface
-\brief CSR interface for sparse matrices (compressed sparse row representation)
+CSR interface for sparse matrices (compressed sparse row representation)
 \ingroup API_Data_Interfaces
 \var starpu_csr_interface::id
 Identifier of the interface
@@ -816,7 +814,7 @@ designated by \p interface.
 \ingroup API_Data_Interfaces
 
 \struct starpu_coo_interface
-\brief COO Matrices
+COO Matrices
 \ingroup API_Data_Interfaces
 \var starpu_coo_interface::id
 identifier of the interface

doc/doxygen/chapters/api/data_partition.doxy

@@ -9,7 +9,8 @@
 /*! \defgroup API_Data_Partition Data Partition
 
 \struct starpu_data_filter
-\brief The filter structure describes a data partitioning operation, to be given to the starpu_data_partition() function.
+The filter structure describes a data partitioning operation, to be
+given to the starpu_data_partition() function.
 \ingroup API_Data_Partition
 \var starpu_data_filter::filter_func
 This function fills the child_interface structure with interface

doc/doxygen/chapters/api/explicit_dependencies.doxy

@@ -10,7 +10,7 @@
 
 \fn void starpu_task_declare_deps_array(struct starpu_task *task, unsigned ndeps, struct starpu_task *task_array[])
 \ingroup API_Explicit_Dependencies
-\brief Declare task dependencies between a \p task and an array of
+Declare task dependencies between a \p task and an array of
 tasks of length \p ndeps. This function must be called prior to the
 submission of the task, but it may called after the submission or the
 execution of the tasks in the array, provided the tasks are still
@@ -24,7 +24,7 @@ redundancy in the task dependencies.
 
 \typedef starpu_tag_t
 \ingroup API_Explicit_Dependencies
-\brief This type defines a task logical identifer. It is possible to
+This type defines a task logical identifer. It is possible to
 associate a task with a unique <em>tag</em> chosen by the application,
 and to express dependencies between tasks by the means of those tags.
 To do so, fill the field starpu_task::tag_id with a tag number (can be
@@ -35,7 +35,7 @@ dependency tags are completed.
 
 \fn void starpu_tag_declare_deps(starpu_tag_t id, unsigned ndeps, ...)
 \ingroup API_Explicit_Dependencies
-\brief Specify the dependencies of the task identified by tag \p id.
+Specify the dependencies of the task identified by tag \p id.
 The first argument specifies the tag which is configured, the second
 argument gives the number of tag(s) on which \p id depends. The
 following arguments are the tags which have to be terminated to unlock
@@ -58,7 +58,7 @@ starpu_tag_declare_deps((starpu_tag_t)0x1, 2, (starpu_tag_t)0x32, (starpu_tag_t)
 
 \fn void starpu_tag_declare_deps_array(starpu_tag_t id, unsigned ndeps, starpu_tag_t *array)
 \ingroup API_Explicit_Dependencies
-\brief This function is similar to starpu_tag_declare_deps(), except
+This function is similar to starpu_tag_declare_deps(), except
 that its does not take a variable number of arguments but an array of
 tags of size \p ndeps.
 
@@ -70,7 +70,7 @@ starpu_tag_declare_deps_array((starpu_tag_t)0x1, 2, tag_array);
 
 \fn int starpu_tag_wait(starpu_tag_t id)
 \ingroup API_Explicit_Dependencies
-\brief This function blocks until the task associated to tag \p id has
+This function blocks until the task associated to tag \p id has
 been executed. This is a blocking call which must therefore not be
 called within tasks or callbacks, but only from the application
 directly. It is possible to synchronize with the same tag multiple
@@ -81,13 +81,13 @@ starpu_task::destroy was enabled).
 
 \fn int starpu_tag_wait_array(unsigned ntags, starpu_tag_t *id)
 \ingroup API_Explicit_Dependencies
-\brief This function is similar to starpu_tag_wait() except that it
+This function is similar to starpu_tag_wait() except that it
 blocks until all the \p ntags tags contained in the array \p id are
 terminated.
 
 \fn void starpu_tag_restart(starpu_tag_t id)
 \ingroup API_Explicit_Dependencies
-\brief This function can be used to clear the <em>already
+This function can be used to clear the <em>already
 notified</em> status of a tag which is not associated with a task.
 Before that, calling starpu_tag_notify_from_apps() again will not
 notify the successors. After that, the next call to
@@ -95,13 +95,13 @@ starpu_tag_notify_from_apps() will notify the successors.
 
 \fn void starpu_tag_remove(starpu_tag_t id)
 \ingroup API_Explicit_Dependencies
-\brief This function releases the resources associated to tag \p id.
+This function releases the resources associated to tag \p id.
 It can be called once the corresponding task has been executed and
 when there is no other tag that depend on this tag anymore.
 
 \fn void starpu_tag_notify_from_apps (starpu_tag_t id)
 \ingroup API_Explicit_Dependencies
-\brief This function explicitly unlocks tag \p id. It may be useful in
+This function explicitly unlocks tag \p id. It may be useful in
 the case of applications which execute part of their computation
 outside StarPU tasks (e.g. third-party libraries). It is also provided
 as a convenient tool for the programmer, for instance to entirely

doc/doxygen/chapters/api/fxt_support.doxy

@@ -9,7 +9,7 @@
 /*! \defgroup API_FxT_Support FxT Support
 
 \struct starpu_fxt_codelet_event
-\brief todo
+todo
 \ingroup API_FxT_Support
 \var starpu_fxt_codelet_event::symbol[256
 name of the codelet
@@ -20,7 +20,7 @@ name of the codelet
 \var starpu_fxt_codelet_event::time
 
 \struct starpu_fxt_options
-\brief todo
+todo
 \ingroup API_FxT_Support
 \var starpu_fxt_options::per_task_colour
 \var starpu_fxt_options::no_counter

doc/doxygen/chapters/api/implicit_dependencies.doxy

@@ -20,7 +20,7 @@ also inserted in the case of data accesses from the application.
 
 \fn starpu_data_set_default_sequential_consistency_flag(unsigned flag)
 \ingroup API_Implicit_Data_Dependencies
-\brief Set the default sequential consistency flag. If a non-zero
+Set the default sequential consistency flag. If a non-zero
 value is passed, a sequential data consistency will be enforced for
 all handles registered after this function call, otherwise it is
 disabled. By default, StarPU enables sequential data consistency. It
@@ -30,11 +30,11 @@ starpu_data_set_sequential_consistency_flag().
 
 \fn unsigned starpu_data_get_default_sequential_consistency_flag(void)
 \ingroup API_Implicit_Data_Dependencies
-\brief Return the default sequential consistency flag
+Return the default sequential consistency flag
 
 \fn void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag)
 \ingroup API_Implicit_Data_Dependencies
-\brief Set the data consistency mode associated to a data handle. The
+Set the data consistency mode associated to a data handle. The
 consistency mode set using this function has the priority over the
 default mode which can be set with
 starpu_data_set_default_sequential_consistency_flag().

doc/doxygen/chapters/api/initialization.doxy

@@ -9,7 +9,7 @@
 /*! \defgroup API_Initialization_and_Termination Initialization and Termination
 
 \struct starpu_driver
-\brief structure for a driver
+structure for a driver
 \ingroup API_Initialization_and_Termination
 \var starpu_driver::type
 The type of the driver. Only STARPU_CPU_DRIVER,
@@ -18,14 +18,11 @@ STARPU_CUDA_DRIVER and STARPU_OPENCL_DRIVER are currently supported.
 The identifier of the driver.
 
 \struct starpu_vector_interface
-\brief vector interface for contiguous (non-strided) buffers
+vector interface for contiguous (non-strided) buffers
 \ingroup API_Initialization_and_Termination
 
-
 \struct starpu_conf
 \ingroup API_Initialization_and_Termination
-\brief structure for configuring StarPU.
-
 This structure is passed to the starpu_init() function in order to
 configure StarPU. It has to be initialized with starpu_conf_init().
 When the default value is used, StarPU automatically selects the

doc/doxygen/chapters/api/insert_task.doxy

@@ -10,7 +10,7 @@
 
 \fn int starpu_insert_task(struct starpu_codelet *cl, ...)
 \ingroup API_Insert_Task
-\brief Create and submit a task corresponding to \p cl with the
+Create and submit a task corresponding to \p cl with the
 following arguments. The argument list must be zero-terminated.
 
 The arguments following the codelets can be of the following types:
@@ -35,18 +35,18 @@ implementation to retrieve them.
 
 \def STARPU_VALUE
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must
+this macro is used when calling starpu_insert_task(), and must
 be followed by a pointer to a constant value and the size of the
 constant
 
 \def STARPU_CALLBACK
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must
+this macro is used when calling starpu_insert_task(), and must
 be followed by a pointer to a callback function
 
 \def STARPU_CALLBACK_WITH_ARG
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must
+this macro is used when calling starpu_insert_task(), and must
 be followed by two pointers: one to a callback function, and the other
 to be given as an argument to the callback function; this is
 equivalent to using both ::STARPU_CALLBACK and
@@ -54,45 +54,45 @@ equivalent to using both ::STARPU_CALLBACK and
 
 \def STARPU_CALLBACK_ARG
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must
+this macro is used when calling starpu_insert_task(), and must
 be followed by a pointer to be given as an argument to the callback
 function
 
 \def STARPU_PRIORITY
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must
+this macro is used when calling starpu_insert_task(), and must
 be followed by a integer defining a priority level
 
 \def STARPU_DATA_ARRAY
 \ingroup API_Insert_Task
-\brief TODO
+TODO
 
 \def STARPU_TAG
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must be followed by a tag.
+this macro is used when calling starpu_insert_task(), and must be followed by a tag.
 
 \def STARPU_FLOPS
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must
+this macro is used when calling starpu_insert_task(), and must
 be followed by an amount of floating point operations, as a double.
 Users <b>MUST</b> explicitly cast into double, otherwise parameter
 passing will not work.
 
 \def STARPU_SCHED_CTX
 \ingroup API_Insert_Task
-\brief this macro is used when calling starpu_insert_task(), and must
+this macro is used when calling starpu_insert_task(), and must
 be followed by the id of the scheduling context to which we want to
 submit the task.
 
 \fn void starpu_codelet_pack_args(void **arg_buffer, size_t *arg_buffer_size, ...)
 \ingroup API_Insert_Task
-\brief Pack arguments of type ::STARPU_VALUE into a buffer which can be
+Pack arguments of type ::STARPU_VALUE into a buffer which can be
 given to a codelet and later unpacked with the function
 starpu_codelet_unpack_args().
 
 \fn void starpu_codelet_unpack_args (void *cl_arg, ...)
 \ingroup API_Insert_Task
-\brief Retrieve the arguments of type ::STARPU_VALUE associated to a
+Retrieve the arguments of type ::STARPU_VALUE associated to a
 task automatically created using the function starpu_insert_task().
 
 */

doc/doxygen/chapters/api/multiformat_data_interface.doxy

@@ -10,7 +10,7 @@
 
 \struct starpu_multiformat_data_interface_ops
 \ingroup API_Multiformat_Data_Interface
-\brief The different fields are:
+The different fields are:
 \var starpu_multiformat_data_interface_ops::cpu_elemsize
         the size of each element on CPUs
 \var starpu_multiformat_data_interface_ops::opencl_elemsize
@@ -27,7 +27,7 @@
         pointer to a codelet which converts from CUDA to CPU
 
 \struct starpu_multiformat_interface
-\brief todo
+todo
 \ingroup API_Multiformat_Data_Interface
 \var starpu_multiformat_interface::id
 \var starpu_multiformat_interface::cpu_ptr

doc/doxygen/chapters/api/opencl_extensions.doxy

@@ -10,11 +10,18 @@
 
 \def STARPU_USE_OPENCL
 \ingroup API_OpenCL_Extensions
-\brief This macro is defined when StarPU has been installed with
+This macro is 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 Full source code for the 'Scaling a
 Vector' example.
 
+\struct starpu_opencl_program
+\ingroup API_OpenCL_Extensions
+Stores the OpenCL programs as compiled for the different OpenCL
+devices.
+\var starpu_opencl_program::programs
+Stores each program for each OpenCL device.
+
 @name Writing OpenCL kernels
 \ingroup API_OpenCL_Extensions
 
@@ -76,13 +83,6 @@ starpu_opencl_program array by hand for more advanced use (e.g.
 different programs on the different OpenCL devices, for relocation
 purpose for instance).
 
-\struct starpu_opencl_program
-\ingroup API_OpenCL_Extensions
-\brief Stores the OpenCL programs as compiled for the different OpenCL
-devices.
-\var starpu_opencl_program::programs
-Stores each program for each OpenCL device.
-
 \fn int starpu_opencl_load_opencl_from_file(const char *source_file_name, struct starpu_opencl_program *opencl_programs, const char* build_options)
 \ingroup API_OpenCL_Extensions
 This function compiles an OpenCL source code stored in a file.

doc/doxygen/chapters/api/performance_model.doxy

@@ -10,7 +10,7 @@
 
 \enum starpu_perfmodel_archtype
 \ingroup API_Performance_Model
-\brief Enumerates the various types of architectures.
+Enumerates the various types of architectures.
 
 it is possible that we have multiple versions of the same kind of
 workers, for instance multiple GPUs or even different CPUs within
@@ -49,7 +49,7 @@ SCC workers
 
 \enum starpu_perfmodel_type
 \ingroup API_Performance_Model
-\brief TODO
+TODO
 \var starpu_perfmodel_type::STARPU_PER_ARCH
 \ingroup API_Performance_Model
 Application-provided per-arch cost model function
@@ -67,7 +67,7 @@ Automatic linear regression-based cost model  (alpha * size ^ beta)
 Automatic non-linear regression-based cost model (a * size ^ b + c)
 
 \struct starpu_perfmodel
-\brief Contains all information about a performance model. At least the
+Contains all information about a performance model. At least the
 type and symbol fields have to be filled when defining a performance
 model for a codelet. For compatibility, make sure to initialize the
 whole structure to zero, either by using explicit memset, or by
@@ -119,7 +119,7 @@ Lock to protect concurrency between loading from disk (W), updating
 the values (W), and making a performance estimation (R).
 
 \struct starpu_perfmodel_regression_model
-\brief ...
+...
 \ingroup API_Performance_Model
 \var starpu_perfmodel_regression_model::sumlny
 sum of ln(measured)
@@ -151,7 +151,7 @@ whether the non-linear regression model is valid (i.e. enough measures)
 number of sample values for non-linear regression
 
 \struct starpu_perfmodel_per_arch
-\brief contains information about the performance model of a given
+contains information about the performance model of a given
 arch.
 \ingroup API_Performance_Model
 \var starpu_perfmodel_per_arch::cost_model
@@ -180,7 +180,7 @@ Used by ::STARPU_HISTORY_BASED and
 regression.
 
 \struct starpu_perfmodel_history_list
-\brief todo
+todo
 \ingroup API_Performance_Model
 \var starpu_perfmodel_history_list::next
 todo
@@ -188,7 +188,7 @@ todo
 todo
 
 \struct starpu_perfmodel_history_entry
-\brief todo
+todo
 \ingroup API_Performance_Model
 \var starpu_perfmodel_history_entry::mean
 mean_n = 1/n sum

doc/doxygen/chapters/api/profiling.doxy

@@ -10,7 +10,7 @@
 
 \struct starpu_profiling_task_info
 \ingroup API_Profiling
-\brief This structure contains information about the execution of a
+This structure contains information about the execution of a
 task. It is accessible from the field starpu_task::profiling_info if
 profiling was enabled.
 \var starpu_profiling_task_info::submit_time
@@ -65,7 +65,7 @@ Time when the worker finished releasing data.
         Power consumed by the task, only available in the MoviSim
 
 \struct starpu_profiling_worker_info
-\brief This structure contains the profiling information associated to
+This structure contains the profiling information associated to
 a worker. The timing is provided since the previous call to
 starpu_profiling_worker_get_info()
 \ingroup API_Profiling
@@ -87,7 +87,7 @@ starpu_profiling_worker_get_info()
         Power consumed by the worker, only available in the MoviSim
 
 \struct starpu_profiling_bus_info
-\brief todo
+todo
 \ingroup API_Profiling
 \var starpu_profiling_bus_info::start_time
         Time of bus profiling startup.

doc/doxygen/chapters/api/scheduling_context_hypervisor.doxy

@@ -10,7 +10,7 @@
 
 \struct sc_hypervisor_policy
 \ingroup API_Scheduling_Context_Hypervisor
-\brief This structure contains all the methods that implement a hypervisor resizing policy.
+This structure contains all the methods that implement a hypervisor resizing policy.
 \var sc_hypervisor_policy::name
         Indicates the name of the policy, if there is not a custom policy, the policy corresponding to this name will be used by the hypervisor
 \var sc_hypervisor_policy::custom
@@ -28,7 +28,7 @@
 
 \struct sc_hypervisor_policy_config
 \ingroup API_Scheduling_Context_Hypervisor
-\brief This structure contains all configuration information of a
+This structure contains all configuration information of a
 context. It contains configuration information for each context, which
 can be used to construct new resize strategies.
 \var sc_hypervisor_policy_config::min_nworkers
@@ -48,7 +48,7 @@ can be used to construct new resize strategies.
 
 \struct sc_hypervisor_wrapper
 \ingroup API_Scheduling_Context_Hypervisor
-\brief This structure is a wrapper of the contexts available in StarPU
+This structure is a wrapper of the contexts available in StarPU
 and contains all information about a context obtained by incrementing
 the performance counters.
 \var sc_hypervisor_wrapper::sched_ctx
@@ -76,7 +76,7 @@ the performance counters.
 
 \struct sc_hypervisor_resize_ack
 \ingroup API_Scheduling_Context_Hypervisor
-\brief This structures checks if the workers moved to another context
+This structures checks if the workers moved to another context
 are actually taken into account in that context.
 \var sc_hypervisor_resize_ack::receiver_sched_ctx
         The context receiving the new workers
@@ -89,7 +89,7 @@ are actually taken into account in that context.
 	into account in the new context if 0 not yet
 
 \struct sc_hypervisor_policy_task_pool
-\brief task wrapper linked list
+task wrapper linked list
 \ingroup API_Scheduling_Context_Hypervisor
 \var sc_hypervisor_policy_task_pool::cl
 Which codelet has been executed

doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -23,8 +23,42 @@ types of structures the worker collection can implement
 \ingroup API_Scheduling_Contexts
 List of workers
 
+\struct starpu_sched_ctx_iterator
+\ingroup API_Scheduling_Contexts
+todo
+\var starpu_sched_ctx_iterator::cursor
+todo
+
+\struct starpu_worker_collection
+\ingroup API_Scheduling_Contexts
+A scheduling context manages a collection of workers that can
+be memorized using different data structures. Thus, a generic
+structure is available in order to simplify the choice of its type.
+Only the list data structure is available but further data
+structures(like tree) implementations are foreseen.
+\var starpu_worker_collection::workerids
+        The workerids managed by the collection
+\var starpu_worker_collection::nworkers
+        The number of workers in the collection
+\var starpu_worker_collection::type
+        The type of structure (currently ::STARPU_WORKER_LIST is the only one available)
+\var starpu_worker_collection::has_next
+        Checks if there is another element in collection
+\var starpu_worker_collection::get_next
+        return the next element in the collection
+\var starpu_worker_collection::add
+        add a new element in the collection
+\var starpu_worker_collection::remove
+        remove an element from the collection
+\var starpu_worker_collection::init
+        Initialize the collection
+\var starpu_worker_collection::deinit
+        Deinitialize the colection
+\var starpu_worker_collection::init_iterator
+        Initialize the cursor if there is one
+
 \struct starpu_sched_ctx_performance_counters
-\brief Performance counters used by the starpu to indicate the
+Performance counters used by the starpu to indicate the
 hypervisor how the application and the resources are executing.
 \ingroup API_Scheduling_Contexts
 \var starpu_sched_ctx_performance_counters::notify_idle_cycle
@@ -178,40 +212,6 @@ policy of the given scheduler context.
 @name Scheduling Context Worker Collection
 \ingroup API_Scheduling_Contexts
 
-\struct starpu_sched_ctx_iterator
-\ingroup API_Scheduling_Contexts
-\brief todo
-\var starpu_sched_ctx_iterator::cursor
-todo
-
-\struct starpu_worker_collection
-\ingroup API_Scheduling_Contexts
-\brief A scheduling context manages a collection of workers that can
-be memorized using different data structures. Thus, a generic
-structure is available in order to simplify the choice of its type.
-Only the list data structure is available but further data
-structures(like tree) implementations are foreseen.
-\var starpu_worker_collection::workerids
-        The workerids managed by the collection
-\var starpu_worker_collection::nworkers
-        The number of workers in the collection
-\var starpu_worker_collection::type
-        The type of structure (currently ::STARPU_WORKER_LIST is the only one available)
-\var starpu_worker_collection::has_next
-        Checks if there is another element in collection
-\var starpu_worker_collection::get_next
-        return the next element in the collection
-\var starpu_worker_collection::add
-        add a new element in the collection
-\var starpu_worker_collection::remove
-        remove an element from the collection
-\var starpu_worker_collection::init
-        Initialize the collection
-\var starpu_worker_collection::deinit
-        Deinitialize the colection
-\var starpu_worker_collection::init_iterator
-        Initialize the cursor if there is one
-
 \fn struct starpu_worker_collection* starpu_sched_ctx_create_worker_collection(unsigned sched_ctx_id, enum starpu_worker_collection_type type)
 \ingroup API_Scheduling_Contexts
 Create a worker collection of the type indicated by the last parameter

doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -15,7 +15,7 @@ described below allows users to write their own scheduling policy.
 
 \struct starpu_sched_policy
 \ingroup API_Scheduling_Policy
-\brief This structure contains all the methods that implement a
+This structure contains all the methods that implement a
 scheduling policy. An application may specify which scheduling
 strategy in the field starpu_conf::sched_policy passed to the function
 starpu_init().

doc/doxygen/chapters/api/standard_memory_library.doxy

@@ -10,11 +10,11 @@
 
 \def STARPU_MALLOC_PINNED
 \ingroup API_Standard_Memory_Library
-\brief Value passed to the function starpu_malloc_flags() to indicate the memory allocation should be pinned. 
+Value passed to the function starpu_malloc_flags() to indicate the memory allocation should be pinned.
 
 \def STARPU_MALLOC_COUNT
 \ingroup API_Standard_Memory_Library
-\brief Value passed to the function starpu_malloc_flags() to indicate
+Value passed to the function starpu_malloc_flags() to indicate
 the memory allocation should be in the limit defined by the
 environment variables <c>STARPU_LIMIT_CUDA_devid_MEM</c>,
 <c>STARPU_LIMIT_CUDA_MEM</c>, <c>STARPU_LIMIT_OPENCL_devid_MEM</c>,
@@ -22,23 +22,23 @@ environment variables <c>STARPU_LIMIT_CUDA_devid_MEM</c>,
 Section \ref How_to_limit_memory_per_node).
 If no memory is available, it tries to reclaim memory from StarPU.
 Memory allocated this way needs to be freed by calling the
-starpu_free_flags() function with the same flag. 
+starpu_free_flags() function with the same flag.
 
 \fn int starpu_malloc_flags(void **A, size_t dim, int flags)
 \ingroup API_Standard_Memory_Library
-\brief Performs a memory allocation based on the constraints defined
+Performs a memory allocation based on the constraints defined
 by the given flag.
 
 \fn void starpu_malloc_set_align(size_t align)
 \ingroup API_Standard_Memory_Library
-\brief This function sets an alignment constraints for starpu_malloc()
+This function sets an alignment constraints for starpu_malloc()
 allocations. align must be a power of two. This is for instance called
 automatically by the OpenCL driver to specify its own alignment
 constraints.
 
 \fn int starpu_malloc(void **A, size_t dim)
 \ingroup API_Standard_Memory_Library
-\brief This function allocates data of the given size in main memory.
+This function allocates data of the given size in main memory.
 It will also try to pin it in CUDA or OpenCL, so that data transfers
 from this buffer can be asynchronous, and thus permit data transfer
 and computation overlapping. The allocated buffer must be freed thanks
@@ -46,20 +46,19 @@ to the starpu_free() function.
 
 \fn int starpu_free(void *A)
 \ingroup API_Standard_Memory_Library
-\brief This function frees memory which has previously been allocated
+This function frees memory which has previously been allocated
 with starpu_malloc().
 
 \fn int starpu_free_flags(void *A, size_t dim, int flags)
 \ingroup API_Standard_Memory_Library
-\brief This function frees memory by specifying its size. The given
+This function frees memory by specifying its size. The given
 flags should be consistent with the ones given to starpu_malloc_flags()
 when allocating the memory.
 
 \fn ssize_t starpu_memory_get_available(unsigned node)
 \ingroup API_Standard_Memory_Library
-\brief If a memory limit is defined on the given node (see Section \ref
+If a memory limit is defined on the given node (see Section \ref
 How_to_limit_memory_per_node), return the amount of available memory
 on the node. Otherwise return -1.
 
 */
-

doc/doxygen/chapters/api/task_lists.doxy

@@ -9,7 +9,7 @@
 /*! \defgroup API_Task_Lists Task Lists
 
 \struct starpu_task_list
-\brief Stores a double-chained list of tasks
+Stores a double-chained list of tasks
 \ingroup API_Task_Lists
 \var starpu_task_list::head
 head of the list

doc/doxygen/chapters/api/top.doxy

@@ -10,7 +10,7 @@
 
 \enum starpu_top_data_type
 \ingroup API_StarPU-Top_Interface
-\brief StarPU-Top Data type
+StarPU-Top Data type
 \var starpu_top_data_type::STARPU_TOP_DATA_BOOLEAN
 \ingroup API_StarPU-Top_Interface
 todo
@@ -23,7 +23,7 @@ todo
 
 \enum starpu_top_param_type
 \ingroup API_StarPU-Top_Interface
-\brief StarPU-Top Parameter type
+StarPU-Top Parameter type
 \var starpu_top_param_type::STARPU_TOP_PARAM_BOOLEAN
 \ingroup API_StarPU-Top_Interface
 todo
@@ -39,7 +39,7 @@ todo
 
 \enum starpu_top_message_type
 \ingroup API_StarPU-Top_Interface
-\brief StarPU-Top Message type
+StarPU-Top Message type
 \var starpu_top_message_type::TOP_TYPE_GO
 \ingroup API_StarPU-Top_Interface
 todo
@@ -63,7 +63,7 @@ todo
 todo
 
 \struct starpu_top_data
-\brief todo
+todo
 \ingroup API_StarPU-Top_Interface
 \var starpu_top_data::id
 todo
@@ -85,7 +85,7 @@ todo
 todo
 
 \struct starpu_top_param
-\brief todo
+todo
 \ingroup API_StarPU-Top_Interface
 \var starpu_top_param::id
 todo

doc/doxygen/chapters/api/versioning.doxy

@@ -10,19 +10,19 @@
 
 \def STARPU_MAJOR_VERSION
 \ingroup API_Versioning
-\brief Define the major version of StarPU. This is the version used when compiling the application.
+Define the major version of StarPU. This is the version used when compiling the application.
 
 \def STARPU_MINOR_VERSION
 \ingroup API_Versioning
-\brief Define the minor version of StarPU. This is the version used when compiling the application.
+Define the minor version of StarPU. This is the version used when compiling the application.
 
 \def STARPU_RELEASE_VERSION
 \ingroup API_Versioning
-\brief Define the release version of StarPU. This is the version used when compiling the application.
+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
-\brief Return as 3 integers the version of StarPU used when running the application.
+Return as 3 integers the version of StarPU used when running the application.
 
 */
 

doc/doxygen/chapters/api/workers.doxy

@@ -37,7 +37,7 @@ TODO
 
 \enum starpu_worker_archtype
 \ingroup API_Workers_Properties
-\brief Worker Architecture Type
+Worker Architecture Type
 \var starpu_worker_archtype::STARPU_ANY_WORKER
 \ingroup API_Workers_Properties
 any worker, used in the hypervisor
@@ -60,34 +60,34 @@ Intel SCC device
 
 \fn unsigned starpu_worker_get_count(void)
 \ingroup API_Workers_Properties
-\brief This function returns the number of workers (i.e. processing
+This function returns the number of workers (i.e. processing
 units executing StarPU tasks). The returned value should be at most
 STARPU_NMAXWORKERS.
 
 \fn int starpu_worker_get_count_by_type(enum starpu_worker_archtype type)
 \ingroup API_Workers_Properties
-\brief Returns the number of workers of the given type. A positive (or
+Returns the number of workers of the given type. A positive (or
 NULL) value is returned in case of success, -EINVAL indicates that the
 type is not valid otherwise.
 
 \fn unsigned starpu_cpu_worker_get_count(void)
 \ingroup API_Workers_Properties
-\brief This function returns the number of CPUs controlled by StarPU. The
+This function returns the number of CPUs controlled by StarPU. The
 returned value should be at most STARPU_MAXCPUS.
 
 \fn unsigned starpu_cuda_worker_get_count(void)
 \ingroup API_Workers_Properties
-\brief This function returns the number of CUDA devices controlled by
+This function returns the number of CUDA devices controlled by
 StarPU. The returned value should be at most STARPU_MAXCUDADEVS.
 
 \fn unsigned starpu_opencl_worker_get_count(void)
 \ingroup API_Workers_Properties
-\brief This function returns the number of OpenCL devices controlled by
+This function returns the number of OpenCL devices controlled by
 StarPU. The returned value should be at most STARPU_MAXOPENCLDEVS.
 
 \fn int starpu_worker_get_id (void)
 \ingroup API_Workers_Properties
-\brief This function returns the identifier of the current worker, i.e
+This function returns the identifier of the current worker, i.e
 the one associated to the calling thread. The returned value is either
 -1 if the current context is not a StarPU worker (i.e. when called
 from the application outside a task or a callback), or an integer
@@ -95,7 +95,7 @@ between 0 and starpu_worker_get_count() - 1.
 
 \fn int starpu_worker_get_ids_by_type(enum starpu_worker_archtype type, int *workerids, int maxsize)
 \ingroup API_Workers_Properties
-\brief This function gets the list of identifiers of workers with the
+This function gets the list of identifiers of workers with the
 given type. It fills the workerids array with the identifiers of the
 workers that have the type indicated in the first argument. The
 maxsize argument indicates the size of the workids array. The returned
@@ -109,18 +109,18 @@ STARPU_NMAXWORKERS.
 
 \fn int starpu_worker_get_by_type(enum starpu_worker_archtype type, int num)
 \ingroup API_Workers_Properties
-\brief This returns the identifier of the num-th worker that has the
+This returns the identifier of the num-th worker that has the
 specified type type. If there are no such worker, -1 is returned.
 
 \fn int starpu_worker_get_by_devid(enum starpu_worker_archtype type, int devid)
 \ingroup API_Workers_Properties
-\brief This returns the identifier of the worker that has the specified type
+This returns the identifier of the worker that has the specified type
 type and devid devid (which may not be the n-th, if some devices are
 skipped for instance). If there are no such worker, -1 is returned.
 
 \fn int starpu_worker_get_devid(int id)
 \ingroup API_Workers_Properties
-\brief This function returns the device id of the given worker. The
+This function returns the device id of the given worker. The
 worker should be identified with the value returned by the
 starpu_worker_get_id() function. In the case of a CUDA worker, this
 device identifier is the logical device identifier exposed by CUDA
@@ -131,7 +131,7 @@ OS or by the hwloc library in case it is available.
 
 \fn enum starpu_worker_archtype starpu_worker_get_type(int id)
 \ingroup API_Workers_Properties
-\brief This function returns the type of processing unit associated to
+This function returns the type of processing unit associated to
 a worker. The worker identifier is a value returned by the
 starpu_worker_get_id() function). The returned value indicates the
 architecture of the worker: STARPU_CPU_WORKER for a CPU core,
@@ -141,7 +141,7 @@ unspecified.
 
 \fn void starpu_worker_get_name(int id, char *dst, size_t maxlen)
 \ingroup API_Workers_Properties
-\brief This function allows to get the name of a given worker. StarPU
+This function allows to get the name of a given worker. StarPU
 associates a unique human readable string to each processing unit.
 This function copies at most the maxlen first bytes of the unique
 string associated to a worker identified by its identifier id into the
@@ -151,12 +151,12 @@ function on an invalid identifier results in an unspecified behaviour.
 
 \fn unsigned starpu_worker_get_memory_node(unsigned workerid)
 \ingroup API_Workers_Properties
-\brief This function returns the identifier of the memory node
+This function returns the identifier of the memory node
 associated to the worker identified by workerid.
 
 \fn enum starpu_node_kind starpu_node_get_kind(unsigned node)
 \ingroup API_Workers_Properties
-\brief Returns the type of the given node as defined by
+Returns the type of the given node as defined by
 ::starpu_node_kind. For example, when defining a new data interface,
 this function should be used in the allocation function to determine
 on which device the memory needs to be allocated.