Browse Source

doc: formatting updates

Nathalie Furmento 6 years ago
parent
commit
d27d63efd6

+ 19 - 19
doc/doxygen/chapters/495_interoperability.doxy

@@ -55,11 +55,11 @@ LDLIBS += $(shell pkg-config --libs-only-l starpurm-1.3)
 
 \subsection InitExit Initialization and Shutdown
 
-The \c starpurm module is initialized with a call to \ref starpurm_initialize
-and must be finalized with a call to \ref starpurm_shutdown. The \c starpurm
+The \c starpurm module is initialized with a call to starpurm_initialize()
+and must be finalized with a call to starpurm_shutdown(). The \c starpurm
 module supports CPU cores as well as devices. An integer ID is assigned to each
 supported device type. The ID assigned to a given device type can be queried
-with the \ref starpurm_get_device_type_id routine, which currently expects one
+with the starpurm_get_device_type_id() routine, which currently expects one
 of the following strings as argument and returns the corresponding ID:
 <ul>
 <li><c>"cpu"</c></li>
@@ -69,27 +69,27 @@ of the following strings as argument and returns the corresponding ID:
 </ul>
 The \c cpu pseudo device type is defined for convenience and designates CPU
 cores. The number of units of each type available for computation can be
-obtained with a call to \ref starpu_get_nb_devices_by_type.
+obtained with a call to starpu_get_nb_devices_by_type().
 
 Each CPU core unit available for computation is designated by its rank among the
 StarPU CPU worker threads and by its own CPUSET bit. Each non-CPU device unit
 can be designated both by its rank number in the type, and by the CPUSET bit
 corresponding to its StarPU device worker thread. The CPUSET of a computing unit
-or its associated worker can be obtained from its type ID and rank with \ref
-starpurm_get_device_worker_cpuset, which returns the corresponding HWLOC CPUSET. 
+or its associated worker can be obtained from its type ID and rank with 
+starpurm_get_device_worker_cpuset(), which returns the corresponding HWLOC CPUSET. 
 
 
 \subsection DefCTX Default Context
 
 The \c starpurm module assumes a default, global context, manipulated through a
 series of routines allowing to assign and withdraw computing units from the main
-StarPU context. Assigning CPU cores can be done with \ref
-starpurm_assign_cpu_to_starpu and \ref starpurm_assign_cpu_mask_to_starpu, and
-assigning device units can be done with \ref starpurm_assign_device_to_starpu
-and \ref starpurm_assign_device_mask_to_starpu. Conversely, withdrawing CPU
-cores can be done with \ref starpurm_withdraw_cpu_from_starpu and \ref starpurm_withdraw_cpu_mask_from_starpu,
+StarPU context. Assigning CPU cores can be done with
+starpurm_assign_cpu_to_starpu() and starpurm_assign_cpu_mask_to_starpu(), and
+assigning device units can be done with starpurm_assign_device_to_starpu()
+and starpurm_assign_device_mask_to_starpu(). Conversely, withdrawing CPU
+cores can be done with starpurm_withdraw_cpu_from_starpu() and starpurm_withdraw_cpu_mask_from_starpu(=,
 and withdrawing device units can be done with
-\ref starpurm_withdraw_device_from_starpu and \ref starpurm_withdraw_device_mask_from_starpu.
+starpurm_withdraw_device_from_starpu() and starpurm_withdraw_device_mask_from_starpu().
 These routine should typically be used to control resource usage for the main
 applicative code.
 
@@ -97,21 +97,21 @@ applicative code.
 
 Besides the default, global context, \c starpurm can create temporary contexts
 and launch the computation of kernels confined to these temporary contexts.
-The routine \ref starpurm_spawn_kernel_on_cpus can be used to do so: it
+The routine starpurm_spawn_kernel_on_cpus() can be used to do so: it
 allocates a temporary context and spawns a kernel within this context. The
 temporary context is subsequently freed upon completion of the kernel. The
 temporary context is set as the default context for the kernel throughout its
 lifespan. This routine should typically be used to control resource usage for a
 parallel kernel handled by an external library built on StarPU. Internally, it
-relies on the use of \ref starpu_sched_ctx_set_context to set the temporary
-context as default context for the parallel kernel, and then restaure the main
+relies on the use of starpu_sched_ctx_set_context() to set the temporary
+context as default context for the parallel kernel, and then restore the main
 context upon completion. Note: the maximum number of temporary contexts
 allocated concurrently at any time should not exceed
-<c>STARPU_NMAX_SCHED_CTXS-2</c>, otherwise, the call to \ref
-starpurm_spawn_kernel_on_cpus may block until a temporary context becomes
-available. The routine \ref starpurm_spawn_kernel_on_cpus returns upon the
+::STARPU_NMAX_SCHED_CTXS-2, otherwise, the call to
+starpurm_spawn_kernel_on_cpus() may block until a temporary context becomes
+available. The routine starpurm_spawn_kernel_on_cpus() returns upon the
 completion of the parallel kernel. An asynchronous variant is available with the
-routine \ref starpurm_spawn_kernel_on_cpus_callback. This variant returns
+routine starpurm_spawn_kernel_on_cpus_callback(). This variant returns
 immediately, however it accepts a callback function, which is subsequently
 called to notify the calling code about the completion of the parallel kernel.
 

+ 64 - 86
doc/doxygen/chapters/api/interoperability.doxy

@@ -35,11 +35,11 @@ StarPU Resource Manager return type.
 
 \fn void starpurm_initialize(void)
 \ingroup API_Interop_Support
-Initialize StarPU and the StarPU-RM resource management module. The \ref starpu_init function should not have been called before the call to \c starpurm_initialize. The \c starpurm_initialize function will take care of this
+Initialize StarPU and the StarPU-RM resource management module. The starpu_init() function should not have been called before the call to starpurm_initialize(). The starpurm_initialize() function will take care of this
 
 \fn void starpurm_shutdown(void)
 \ingroup API_Interop_Support
-Shutdown StarPU-RM and StarPU. The \ref starpu_shutdown function should not be called before. The \c starpurm_shutdown function will take care of this.
+Shutdown StarPU-RM and StarPU. The starpu_shutdown() function should not be called before. The starpurm_shutdown() function will take care of this.
 
 
 @name Spawn
@@ -48,24 +48,22 @@ Shutdown StarPU-RM and StarPU. The \ref starpu_shutdown function should not be c
 \fn void starpurm_spawn_kernel_on_cpus(void *data, void(*f)(void *), void *args, hwloc_cpuset_t cpuset)
 \ingroup API_Interop_Support
 Allocate a temporary context spanning the units selected in the cpuset bitmap,
-set it as the default context for the current thread, and call user function \c f.
-Upon the return of user function \c f, the temporary context is freed and the previous
+set it as the default context for the current thread, and call user function \p f.
+Upon the return of user function \p f, the temporary context is freed and the previous
 default context for the current thread is restored.
 
 \fn void starpurm_spawn_kernel_on_cpus_callback(void *data, void(*f)(void *), void *args, hwloc_cpuset_t cpuset, void(*cb_f)(void *), void *cb_args)
 \ingroup API_Interop_Support
 Spawn a POSIX thread and returns immediately. The thread spawned will allocate
 a temporary context spanning the units selected in the cpuset bitmap, set it as
-the default context for the current thread, and call user function \c f. Upon
-the return of user function \c f, the temporary context will be freed and the
-previous default context for the current thread restored. A user specified callback \c cb_f
+the default context for the current thread, and call user function \p f. Upon
+the return of user function \p f, the temporary context will be freed and the
+previous default context for the current thread restored. A user specified callback \p cb_f
 will be called just before the termination of the thread.
 
-
 @name DynamicResourceSharing
 \ingroup API_Interop_Support
 
-
 \fn starpurm_drs_ret_t starpurm_set_drs_enable(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
 Turn-on dynamic resource sharing support.
@@ -76,60 +74,51 @@ Turn-off dynamic resource sharing support.
 
 \fn int starpurm_drs_enabled_p(void)
 \ingroup API_Interop_Support
-Return the state of the dynamic resource sharing support (\c =!0 enabled, \c =0 disabled).
+Return the state of the dynamic resource sharing support (\p =!0 enabled, \p =0 disabled).
 
 \fn starpurm_drs_ret_t starpurm_set_max_parallelism(starpurm_drs_desc_t *spd, int max)
 \ingroup API_Interop_Support
 Set the maximum number of CPU computing units available for StarPU computations
-to \c max. This number cannot exceed the maximum number of StarPU's CPU worker
+to \p max. This number cannot exceed the maximum number of StarPU's CPU worker
 allocated at start-up time.
 
-
 \fn starpurm_drs_ret_t starpurm_assign_cpu_to_starpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-
 Extend StarPU's default scheduling context to execute tasks on worker
-corresponding to logical unit \c cpuid. If StarPU does not have a worker
-thread initialized for logical unit \c cpuid, do nothing.
+corresponding to logical unit \p cpuid. If StarPU does not have a worker
+thread initialized for logical unit \p cpuid, do nothing.
 
 \fn starpurm_drs_ret_t starpurm_assign_cpus_to_starpu(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-
-Extend StarPU's default scheduling context to execute tasks on \c ncpus
+Extend StarPU's default scheduling context to execute tasks on \p ncpus
 more workers, up to the number of StarPU worker threads initialized.
 
 \fn starpurm_drs_ret_t starpurm_assign_cpu_mask_to_starpu(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-
 Extend StarPU's default scheduling context to execute tasks on the
-additional logical units selected in \c mask. Logical units of \c mask for which no
+additional logical units selected in \p mask. Logical units of \p mask for which no
 StarPU worker is initialized are silently ignored.
 
 \fn starpurm_drs_ret_t starpurm_assign_all_cpus_to_starpu(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-
 Set StarPU's default scheduling context to execute tasks on all
 available logical units for which a StarPU worker has been initialized.
 
-
 \fn starpurm_drs_ret_t starpurm_withdraw_cpu_from_starpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-
 Shrink StarPU's default scheduling context so as to not execute tasks on worker
-corresponding to logical unit \c cpuid. If StarPU does not have a worker
-thread initialized for logical unit \c cpuid, do nothing.
+corresponding to logical unit \p cpuid. If StarPU does not have a worker
+thread initialized for logical unit \p cpuid, do nothing.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_cpus_from_starpu(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-
-Shrink StarPU's default scheduling context to execute tasks on \c ncpus
+Shrink StarPU's default scheduling context to execute tasks on \p ncpus
 less workers.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_cpu_mask_from_starpu(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-
 Shrink StarPU's default scheduling context so as to not execute tasks on the
-logical units selected in \c mask. Logical units of \c mask for which no
+logical units selected in \p mask. Logical units of \p mask for which no
 StarPU worker is initialized are silently ignored.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_all_cpus_from_starpu(starpurm_drs_desc_t *spd)
@@ -138,61 +127,59 @@ Shrink StarPU's default scheduling context so as to remove all logical units.
 
 \fn starpurm_drs_ret_t starpurm_lend(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_all_cpus_to_starpu.
+Synonym for starpurm_assign_all_cpus_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_lend_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-
-Synonym for \ref starpurm_assign_cpu_to_starpu.
+Synonym for starpurm_assign_cpu_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_lend_cpus(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_cpus_to_starpu.
+Synonym for starpurm_assign_cpus_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_lend_cpu_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_cpu_mask_to_starpu.
+Synonym for starpurm_assign_cpu_mask_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_all_cpus_from_starpu.
+Synonym for starpurm_withdraw_all_cpus_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_cpu_from_starpu.
+Synonym for starpurm_withdraw_cpu_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim_cpus(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_cpus_from_starpu.
+Synonym for starpurm_withdraw_cpus_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim_cpu_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_cpu_mask_from_starpu.
+Synonym for starpurm_withdraw_cpu_mask_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_all_cpus_from_starpu.
+Synonym for starpurm_withdraw_all_cpus_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_cpu_from_starpu.
+Synonym for starpurm_withdraw_cpu_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire_cpus(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_cpus_from_starpu.
+Synonym for starpurm_withdraw_cpus_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire_cpu_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_cpu_mask_from_starpu.
+Synonym for starpurm_withdraw_cpu_mask_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_return_all(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_all_cpus_to_starpu.
+Synonym for starpurm_assign_all_cpus_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_return_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_cpu_to_starpu.
-
+Synonym for starpurm_assign_cpu_to_starpu().
 
 @name Devices
 \ingroup API_Interop_Support
@@ -200,7 +187,7 @@ Synonym for \ref starpurm_assign_cpu_to_starpu.
 \fn int starpurm_get_device_type_id(const char *type_str)
 \ingroup API_Interop_Support
 Return the device type ID constant associated to the device type name.
-Valid names for \c type_str are:
+Valid names for \p type_str are:
 - \c "cpu": regular CPU unit;
 - \c "opencl": OpenCL device unit;
 - \c "cuda": nVidia CUDA device unit;
@@ -212,122 +199,117 @@ Return the device type name associated to the device type ID constant.
 
 \fn int starpurm_get_nb_devices_by_type(int type_id)
 \ingroup API_Interop_Support
-Return the number of initialized StarPU worker for the device type \c type_id.
+Return the number of initialized StarPU worker for the device type \p type_id.
 
 \fn int starpurm_get_device_id(int type_id, int device_rank)
 \ingroup API_Interop_Support
-Return the unique ID assigned to the \c device_rank nth device of type
-\c type_id.
+Return the unique ID assigned to the \p device_rank nth device of type
+\p type_id.
 
 \fn starpurm_drs_ret_t starpurm_assign_device_to_starpu(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-Extend StarPU's default scheduling context to use \c unit_rank nth
-device of type \c type_id.
+Extend StarPU's default scheduling context to use \p unit_rank nth
+device of type \p type_id.
 
 \fn starpurm_drs_ret_t starpurm_assign_devices_to_starpu(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-Extend StarPU's default scheduling context to use \c ndevices more
-devices of type \c type_id, up to the number of StarPU workers
+Extend StarPU's default scheduling context to use \p ndevices more
+devices of type \p type_id, up to the number of StarPU workers
 initialized for such device type.
 
 \fn starpurm_drs_ret_t starpurm_assign_device_mask_to_starpu(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
 Extend StarPU's default scheduling context to use additional devices as
-designated by their corresponding StarPU worker thread(s) CPU-set \c mask.
+designated by their corresponding StarPU worker thread(s) CPU-set \p mask.
 
 \fn starpurm_drs_ret_t starpurm_assign_all_devices_to_starpu(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-Extend StarPU's default scheduling context to use all devices of type \c
+Extend StarPU's default scheduling context to use all devices of type \p
 type_id for which it has a worker thread initialized.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_device_from_starpu(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-
-Shrink StarPU's default scheduling context to not use \c unit_rank nth
-device of type \c type_id.
+Shrink StarPU's default scheduling context to not use \p unit_rank nth
+device of type \p type_id.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_devices_from_starpu(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-
-Shrink StarPU's default scheduling context to use \c ndevices less
-devices of type \c type_id.
+Shrink StarPU's default scheduling context to use \p ndevices less
+devices of type \p type_id.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_device_mask_from_starpu(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-
 Shrink StarPU's default scheduling context to not use devices
-designated by their corresponding StarPU worker thread(s) CPU-set \c mask.
+designated by their corresponding StarPU worker thread(s) CPU-set \p mask.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_all_devices_from_starpu(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-
-Shrink StarPU's default scheduling context to use no devices of type \c
+Shrink StarPU's default scheduling context to use no devices of type \p
 type_id.
 
 \fn starpurm_drs_ret_t starpurm_lend_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_device_to_starpu.
+Synonym for starpurm_assign_device_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_lend_devices(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_devices_to_starpu.
+Synonym for starpurm_assign_devices_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_lend_device_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_device_mask_to_starpu.
+Synonym for starpurm_assign_device_mask_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_lend_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_all_devices_to_starpu.
+Synonym for starpurm_assign_all_devices_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_device_from_starpu.
+Synonym for starpurm_withdraw_device_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim_devices(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_devices_from_starpu.
+Synonym for starpurm_withdraw_devices_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim_device_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_device_mask_from_starpu.
+Synonym for starpurm_withdraw_device_mask_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_reclaim_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_all_devices_from_starpu.
+Synonym for starpurm_withdraw_all_devices_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_device_from_starpu.
+Synonym for starpurm_withdraw_device_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire_devices(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_devices_from_starpu.
+Synonym for starpurm_withdraw_devices_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire_device_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_device_mask_from_starpu.
+Synonym for starpurm_withdraw_device_mask_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_acquire_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_withdraw_all_devices_from_starpu.
+Synonym for starpurm_withdraw_all_devices_from_starpu().
 
 \fn starpurm_drs_ret_t starpurm_return_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_all_devices_to_starpu.
+Synonym for starpurm_assign_all_devices_to_starpu().
 
 \fn starpurm_drs_ret_t starpurm_return_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-Synonym for \ref starpurm_assign_device_to_starpu.
-
+Synonym for starpurm_assign_device_to_starpu().
 
 @name CpusetsQueries
 \ingroup API_Interop_Support
 
 \fn hwloc_cpuset_t starpurm_get_device_worker_cpuset(int type_id, int unit_rank)
 \ingroup API_Interop_Support
-Return the CPU-set of the StarPU worker associated to the \c unit_rank
-nth unit of type \c type_id.
+Return the CPU-set of the StarPU worker associated to the \p unit_rank
+nth unit of type \p type_id.
 
 \fn hwloc_cpuset_t starpurm_get_global_cpuset(void)
 \ingroup API_Interop_Support
@@ -335,24 +317,20 @@ Return the cumulated CPU-set of all StarPU worker threads.
 
 \fn hwloc_cpuset_t starpurm_get_selected_cpuset(void)
 \ingroup API_Interop_Support
-
 Return the CPU-set of the StarPU worker threads currently selected in
 the default StarPU's scheduling context.
 
 \fn hwloc_cpuset_t starpurm_get_all_cpu_workers_cpuset(void)
 \ingroup API_Interop_Support
-
 Return the cumulated CPU-set of all CPU StarPU worker threads.
 
 \fn hwloc_cpuset_t starpurm_get_all_device_workers_cpuset(void)
 \ingroup API_Interop_Support
-
 Return the cumulated CPU-set of all "non-CPU" StarPU worker threads.
 
 \fn hwloc_cpuset_t starpurm_get_all_device_workers_cpuset_by_type(int typeid)
 \ingroup API_Interop_Support
-
 Return the cumulated CPU-set of all StarPU worker threads for devices of
-type \c typeid.
+type \p typeid.
 
 */