Просмотр исходного кода

doc/doxygen: fix macros parameters

Nathalie Furmento лет назад: 12
Родитель
Сommit
ca5200cef5

+ 4 - 4
doc/doxygen/chapters/api/codelet_and_tasks.doxy

@@ -534,7 +534,7 @@ It is possible to initialize statically allocated tasks with
 this value. This is equivalent to initializing a structure starpu_task
 with the function starpu_task_init() function.
 
-\def STARPU_TASK_GET_HANDLE(struct starpu_task *task, int i)
+\def STARPU_TASK_GET_HANDLE(task, i)
 \ingroup API_Codelet_And_Tasks
 Return the \p i th data handle of the given task. If the task
 is defined with a static or dynamic number of handles, will either
@@ -542,7 +542,7 @@ return the \p i th element of the field starpu_task::handles or the \p
 i th element of the field starpu_task::dyn_handles (see \ref
 SettingTheDataHandlesForATask)
 
-\def STARPU_TASK_SET_HANDLE(struct starpu_task *task, starpu_data_handle_t handle, int i)
+\def STARPU_TASK_SET_HANDLE(task, handle, i)
 \ingroup API_Codelet_And_Tasks
 Set the \p i th data handle of the given task with the given
 dat handle. If the task is defined with a static or dynamic number of
@@ -551,7 +551,7 @@ starpu_task::handles or the \p i th element of the field
 starpu_task::dyn_handles (see \ref
 SettingTheDataHandlesForATask)
 
-\def STARPU_CODELET_GET_MODE(struct starpu_codelet *codelet, int i)
+\def STARPU_CODELET_GET_MODE(codelet, i)
 \ingroup API_Codelet_And_Tasks
 Return the access mode of the \p i th data handle of the given
 codelet. If the codelet is defined with a static or dynamic number of
@@ -560,7 +560,7 @@ starpu_codelet::modes or the \p i th element of the field
 starpu_codelet::dyn_modes (see \ref
 SettingTheDataHandlesForATask)
 
-\def STARPU_CODELET_SET_MODE(struct starpu_codelet *codelet, enum starpu_data_access_mode mode, int i)
+\def STARPU_CODELET_SET_MODE(codelet, mode, i)
 \ingroup API_Codelet_And_Tasks
 Set the access mode of the \p i th data handle of the given
 codelet. If the codelet is defined with a static or dynamic number of

+ 2 - 2
doc/doxygen/chapters/api/cuda_extensions.doxy

@@ -35,7 +35,7 @@ This function returns a pointer to device properties for worker
 \ingroup API_CUDA_Extensions
 Report a CUDA error.
 
-\def STARPU_CUDA_REPORT_ERROR(cudaError_t status)
+\def STARPU_CUDA_REPORT_ERROR(status)
 \ingroup API_CUDA_Extensions
 Calls starpu_cuda_report_error(), passing the current function, file and line position.
 
@@ -72,7 +72,7 @@ every CUDA device.
 \ingroup API_CUDA_Extensions
 Report a cublas error.
 
-\def STARPU_CUBLAS_REPORT_ERROR(cublasStatus status)
+\def STARPU_CUBLAS_REPORT_ERROR(status)
 \ingroup API_CUDA_Extensions
 Calls starpu_cublas_report_error(), passing the current
 function, file and line position.

+ 47 - 47
doc/doxygen/chapters/api/data_interfaces.doxy

@@ -368,7 +368,7 @@ Return a device handle for the variable designated by
 \p interface, to be used on OpenCL. The offset documented below has to be
 used in addition to this.
 
-\def STARPU_VARIABLE_GET_OFFSET()
+\def STARPU_VARIABLE_GET_OFFSET(interface)
 \ingroup API_Data_Interfaces
 Return the offset in the variable designated by \p interface, to
 be used with the device handle.
@@ -404,29 +404,29 @@ Return the size of each element of the array designated by \p handle.
 \ingroup API_Data_Interfaces
 Return the local pointer associated with \p handle.
 
-\def STARPU_VECTOR_GET_PTR(void *interface)
+\def STARPU_VECTOR_GET_PTR(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the array designated by \p interface, valid on
 CPUs and CUDA only. For OpenCL, the device handle and offset need to
 be used instead.
 
-\def STARPU_VECTOR_GET_DEV_HANDLE(void *interface)
+\def STARPU_VECTOR_GET_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the array designated by \p interface,
 to be used on OpenCL. the offset documented below has to be used in
 addition to this.
 
-\def STARPU_VECTOR_GET_OFFSET(void *interface)
+\def STARPU_VECTOR_GET_OFFSET(interface)
 \ingroup API_Data_Interfaces
 Return the offset in the array designated by \p interface, to be
 used with the device handle.
 
-\def STARPU_VECTOR_GET_NX(void *interface)
+\def STARPU_VECTOR_GET_NX(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements registered into the array
 designated by \p interface.
 
-\def STARPU_VECTOR_GET_ELEMSIZE(void *interface)
+\def STARPU_VECTOR_GET_ELEMSIZE(interface)
 \ingroup API_Data_Interfaces
 Return the size of each element of the array designated by
 \p interface.
@@ -479,39 +479,39 @@ Return the local pointer associated with \p handle.
 Return the size of the elements registered into the matrix
 designated by \p handle.
 
-\def STARPU_MATRIX_GET_PTR(void *interface)
+\def STARPU_MATRIX_GET_PTR(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the matrix designated by \p interface, valid
 on CPUs and CUDA devices only. For OpenCL devices, the device handle
 and offset need to be used instead.
 
-\def STARPU_MATRIX_GET_DEV_HANDLE(void *interface)
+\def STARPU_MATRIX_GET_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the matrix designated by \p interface,
 to be used on OpenCL. The offset documented below has to be used in
 addition to this.
 
-\def STARPU_MATRIX_GET_OFFSET(void *interface)
+\def STARPU_MATRIX_GET_OFFSET(interface)
 \ingroup API_Data_Interfaces
 Return the offset in the matrix designated by \p interface, to be
 used with the device handle.
 
-\def STARPU_MATRIX_GET_NX(void *interface)
+\def STARPU_MATRIX_GET_NX(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements on the x-axis of the matrix
 designated by \p interface.
 
-\def STARPU_MATRIX_GET_NY(void *interface)
+\def STARPU_MATRIX_GET_NY(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements on the y-axis of the matrix
 designated by \p interface.
 
-\def STARPU_MATRIX_GET_LD(void *interface)
+\def STARPU_MATRIX_GET_LD(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements between each row of the matrix
 designated by \p interface. May be equal to nx when there is no padding.
 
-\def STARPU_MATRIX_GET_ELEMSIZE(void *interface)
+\def STARPU_MATRIX_GET_ELEMSIZE(interface)
 \ingroup API_Data_Interfaces
 Return the size of the elements registered into the matrix
 designated by \p interface.
@@ -522,7 +522,7 @@ designated by \p interface.
 \struct starpu_block_interface
 Block interface for 3D dense blocks
 \ingroup API_Data_Interfaces
-\struct starpu_block_interface::id
+\var starpu_block_interface::id
 identifier of the interface
 \var starpu_block_interface::ptr
 local pointer of the block
@@ -577,48 +577,48 @@ Return the local pointer associated with \p handle.
 Return the size of the elements of the block designated by
 \p handle.
 
-\def STARPU_BLOCK_GET_PTR(void *interface)
+\def STARPU_BLOCK_GET_PTR(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the block designated by \p interface.
 
-\def STARPU_BLOCK_GET_DEV_HANDLE(void *interface)
+\def STARPU_BLOCK_GET_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the block designated by \p interface,
 to be used on OpenCL. The offset document below has to be used in
 addition to this.
 
-\def STARPU_BLOCK_GET_OFFSET(void *interface)
+\def STARPU_BLOCK_GET_OFFSET(interface)
 \ingroup API_Data_Interfaces
 Return the offset in the block designated by \p interface, to be
 used with the device handle.
 
-\def STARPU_BLOCK_GET_NX(void *interface)
+\def STARPU_BLOCK_GET_NX(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements on the x-axis of the block
 designated by \p interface.
 
-\def STARPU_BLOCK_GET_NY(void *interface)
+\def STARPU_BLOCK_GET_NY(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements on the y-axis of the block
 designated by \p interface.
 
-\def STARPU_BLOCK_GET_NZ(void *interface)
+\def STARPU_BLOCK_GET_NZ(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements on the z-axis of the block
 designated by \p interface.
 
-\def STARPU_BLOCK_GET_LDY(void *interface)
+\def STARPU_BLOCK_GET_LDY(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements between each row of the block
 designated by \p interface. May be equal to nx when there is no padding.
 
-\def STARPU_BLOCK_GET_LDZ(void *interface)
+\def STARPU_BLOCK_GET_LDZ(interface)
 \ingroup API_Data_Interfaces
 Return the number of elements between each z plane of the block
 designated by \p interface. May be equal to nx*ny when there is no
 padding.
 
-\def STARPU_BLOCK_GET_ELEMSIZE(void *interface)
+\def STARPU_BLOCK_GET_ELEMSIZE(interface)
 \ingroup API_Data_Interfaces
 Return the size of the elements of the block designated by
 \p interface.
@@ -694,45 +694,45 @@ Return the numberof columns in a block.
 Return the size of the elements in the matrix designated by
 \p handle.
 
-\def STARPU_BCSR_GET_NNZ(void *interface)
+\def STARPU_BCSR_GET_NNZ(interface)
 \ingroup API_Data_Interfaces
 Return the number of non-zero values in the matrix designated
 by \p interface.
 
-\def STARPU_BCSR_GET_NZVAL(void *interface)
+\def STARPU_BCSR_GET_NZVAL(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the non-zero values of the matrix
 designated by \p interface.
 
-\def STARPU_BCSR_GET_NZVAL_DEV_HANDLE(void *interface)
+\def STARPU_BCSR_GET_NZVAL_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the array of non-zero values in the
 matrix designated by \p interface. The offset documented below has to be
 used in addition to this.
 
-\def STARPU_BCSR_GET_COLIND(void *interface)
+\def STARPU_BCSR_GET_COLIND(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the column index of the matrix designated
 by \p interface.
 
-\def STARPU_BCSR_GET_COLIND_DEV_HANDLE(void *interface)
+\def STARPU_BCSR_GET_COLIND_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the column index of the matrix
 designated by \p interface. The offset documented below has to be used in
 addition to this.
 
-\def STARPU_BCSR_GET_ROWPTR(void *interface)
+\def STARPU_BCSR_GET_ROWPTR(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the row pointer array of the matrix
 designated by \p interface.
 
-\def STARPU_CSR_GET_ROWPTR_DEV_HANDLE(void *interface)
+\def STARPU_CSR_GET_ROWPTR_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the row pointer array of the matrix
 designated by \p interface. The offset documented below has to be used in
 addition to this.
 
-\def STARPU_BCSR_GET_OFFSET(void *interface)
+\def STARPU_BCSR_GET_OFFSET
 \ingroup API_Data_Interfaces
 Return the offset in the arrays (coling, rowptr, nzval) of the
 matrix designated by \p interface, to be used with the device handles.
@@ -795,60 +795,60 @@ designated by \p handle.
 Return the size of the elements registered into the matrix
 designated by \p handle.
 
-\def STARPU_CSR_GET_NNZ(void *interface)
+\def STARPU_CSR_GET_NNZ(interface)
 \ingroup API_Data_Interfaces
 Return the number of non-zero values in the matrix designated
 by \p interface.
 
-\def STARPU_CSR_GET_NROW(void *interface)
+\def STARPU_CSR_GET_NROW(interface)
 \ingroup API_Data_Interfaces
 Return the size of the row pointer array of the matrix
 designated by \p interface.
 
-\def STARPU_CSR_GET_NZVAL(void *interface)
+\def STARPU_CSR_GET_NZVAL(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the non-zero values of the matrix
 designated by \p interface.
 
-\def STARPU_CSR_GET_NZVAL_DEV_HANDLE(void *interface)
+\def STARPU_CSR_GET_NZVAL_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the array of non-zero values in the
 matrix designated by \p interface. The offset documented below has to be
 used in addition to this.
 
-\def STARPU_CSR_GET_COLIND(void *interface)
+\def STARPU_CSR_GET_COLIND(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the column index of the matrix designated
 by \p interface.
 
-\def STARPU_CSR_GET_COLIND_DEV_HANDLE(void *interface)
+\def STARPU_CSR_GET_COLIND_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the column index of the matrix
 designated by \p interface. The offset documented below has to be used in
 addition to this.
 
-\def STARPU_CSR_GET_ROWPTR(void *interface)
+\def STARPU_CSR_GET_ROWPTR(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the row pointer array of the matrix
 designated by \p interface.
 
-\def STARPU_CSR_GET_ROWPTR_DEV_HANDLE(void *interface)
+\def STARPU_CSR_GET_ROWPTR_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the row pointer array of the matrix
 designated by \p interface. The offset documented below has to be used in
 addition to this.
 
-\def STARPU_CSR_GET_OFFSET(void *interface)
+\def STARPU_CSR_GET_OFFSET
 \ingroup API_Data_Interfaces
 Return the offset in the arrays (colind, rowptr, nzval) of the
 matrix designated by \p interface, to be used with the device handles.
 
-\def STARPU_CSR_GET_FIRSTENTRY(void *interface)
+\def STARPU_CSR_GET_FIRSTENTRY(interface)
 \ingroup API_Data_Interfaces
 Return the index at which all arrays (the column indexes, the
 row pointers...) of the \p interface start.
 
-\def STARPU_CSR_GET_ELEMSIZE(void *interface)
+\def STARPU_CSR_GET_ELEMSIZE(interface)
 \ingroup API_Data_Interfaces
 Return the size of the elements registered into the matrix
 designated by \p interface.
@@ -876,12 +876,12 @@ number of values registered in the matrix
 \var starpu_coo_interface::elemsize
 size of the elements of the matrix
 
-\def STARPU_COO_GET_COLUMNS(void *interface)
+\def STARPU_COO_GET_COLUMNS(interface)
 \ingroup API_Data_Interfaces
 Return a pointer to the column array of the matrix designated
 by \p interface.
 
-\def STARPU_COO_GET_COLUMNS_DEV_HANDLE(void *interface)
+\def STARPU_COO_GET_COLUMNS_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the column array of the matrix
 designated by \p interface, to be used on OpenCL. The offset documented
@@ -892,7 +892,7 @@ below has to be used in addition to this.
 Return a pointer to the rows array of the matrix designated by
 \p interface.
 
-\def STARPU_COO_GET_ROWS_DEV_HANDLE(void *interface)
+\def STARPU_COO_GET_ROWS_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the row array of the matrix
 designated by \p interface, to be used on OpenCL. The offset documented
@@ -903,13 +903,13 @@ below has to be used in addition to this.
 Return a pointer to the values array of the matrix designated
 by \p interface.
 
-\def STARPU_COO_GET_VALUES_DEV_HANDLE(void *interface)
+\def STARPU_COO_GET_VALUES_DEV_HANDLE(interface)
 \ingroup API_Data_Interfaces
 Return a device handle for the value array of the matrix
 designated by \p interface, to be used on OpenCL. The offset documented
 below has to be used in addition to this.
 
-\def STARPU_COO_GET_OFFSET(void *interface)
+\def STARPU_COO_GET_OFFSET
 \ingroup API_Data_Interfaces
 Return the offset in the arrays of the COO matrix designated by
 \p interface.

+ 1 - 1
doc/doxygen/chapters/api/data_management.doxy

@@ -237,7 +237,7 @@ This is the same as starpu_data_acquire_cb(), except that the
 data will be available on the given memory node instead of main
 memory.
 
-\def STARPU_DATA_ACQUIRE_CB(starpu_data_handle_t handle, enum starpu_data_access_mode mode, code)
+\def STARPU_DATA_ACQUIRE_CB(handle, mode, code)
 \ingroup API_Data_Management
 STARPU_DATA_ACQUIRE_CB() is the same as starpu_data_acquire_cb(),
 except that the code to be executed in a callback is directly provided

+ 4 - 4
doc/doxygen/chapters/api/multiformat_data_interface.doxy

@@ -52,19 +52,19 @@ when working on a CPU, and a structure of arrays when working on a
 GPU. \p nobjects is the number of elements in the data. \p format_ops
 describes the format.
 
-\def STARPU_MULTIFORMAT_GET_CPU_PTR(void *interface)
+\def STARPU_MULTIFORMAT_GET_CPU_PTR(interface)
 \ingroup API_Multiformat_Data_Interface
 returns the local pointer to the data with CPU format.
 
-\def STARPU_MULTIFORMAT_GET_CUDA_PTR(void *interface)
+\def STARPU_MULTIFORMAT_GET_CUDA_PTR(interface)
 \ingroup API_Multiformat_Data_Interface
 returns the local pointer to the data with CUDA format.
 
-\def STARPU_MULTIFORMAT_GET_OPENCL_PTR(void *interface)
+\def STARPU_MULTIFORMAT_GET_OPENCL_PTR(interface)
 \ingroup API_Multiformat_Data_Interface
 returns the local pointer to the data with OpenCL format.
 
-\def STARPU_MULTIFORMAT_GET_NX (void *interface)
+\def STARPU_MULTIFORMAT_GET_NX(interface)
 \ingroup API_Multiformat_Data_Interface
 returns the number of elements in the data.
 

+ 3 - 3
doc/doxygen/chapters/api/opencl_extensions.doxy

@@ -169,7 +169,7 @@ Given a valid error status, prints the corresponding error message on
 stdout, along with the given function name \p func, the given filename
 \p file, the given line number \p line and the given message \p msg.
 
-\def STARPU_OPENCL_DISPLAY_ERROR(cl_int status)
+\def STARPU_OPENCL_DISPLAY_ERROR(status)
 \ingroup API_OpenCL_Extensions
 Call the function starpu_opencl_display_error() with the given error
 \p status, the current function name, current file and line number,
@@ -179,13 +179,13 @@ and a empty message.
 \ingroup API_OpenCL_Extensions
 Call the function starpu_opencl_display_error() and abort.
 
-\def STARPU_OPENCL_REPORT_ERROR (cl_int status)
+\def STARPU_OPENCL_REPORT_ERROR(status)
 \ingroup API_OpenCL_Extensions
 Call the function starpu_opencl_report_error() with the given error \p
 status, with the current function name, current file and line number,
 and a empty message.
 
-\def STARPU_OPENCL_REPORT_ERROR_WITH_MSG(const char *msg, cl_int status)
+\def STARPU_OPENCL_REPORT_ERROR_WITH_MSG(msg, status)
 \ingroup API_OpenCL_Extensions
 Call the function starpu_opencl_report_error() with the given \p msg
 and the given error \p status, with the current function name, current