Sfoglia il codice sorgente

doc: fixes functions prototypes

Nathalie Furmento 10 anni fa
parent
commit
2456b26e1e

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

@@ -82,7 +82,7 @@ asynchronous read, write or copy. Returns 1 on completion, 0 otherwise.
 \var void (*starpu_disk_ops::free_request)(void *async_channel)
 Free the request allocated by a previous asynchronous read, write or copy.
 
-\fn int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, size_t size)
+\fn int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, starpu_ssize_t size)
 \ingroup API_Out_Of_Core
 Register a disk memory node with a set of functions to manipulate datas. The \c
 plug member of \p func will be passed \p parameter, and return a \c base which will be passed to all \p func methods. <br />

+ 9 - 6
doc/doxygen/chapters/api/mpi.doxy

@@ -221,7 +221,7 @@ function does nothing if the cache mechanism is disabled (see
 \anchor MPIInsertTask
 \ingroup API_MPI_Support
 
-\fn int starpu_mpi_data_register_comm(starpu_data_handle_t handle, int tag, int rank, MPI_Comm comm)
+\fn void starpu_mpi_data_register_comm(starpu_data_handle_t data_handle, int tag, int rank, MPI_Comm comm)
 \ingroup API_MPI_Support
 Register to MPI a StarPU data handle with the given tag, rank and MPI communicator.
 It also automatically clears the MPI communication cache when unregistering the data.
@@ -231,21 +231,24 @@ It also automatically clears the MPI communication cache when unregistering the
 Register to MPI a StarPU data handle with the given tag, rank and the MPI communicator MPI_COMM_WORLD.
 It also automatically clears the MPI communication cache when unregistering the data.
 
-\fn int starpu_data_set_tag(starpu_data_handle_t handle, int tag)
+\fn void starpu_mpi_data_set_tag(starpu_data_handle_t handle, int tag)
 \ingroup API_MPI_Support
 Register to MPI a StarPU data handle with the given tag. No rank will be defined.
 It also automatically clears the MPI communication cache when unregistering the data.
 
-\fn int starpu_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm)
+\def starpu_data_set_tag
 \ingroup API_MPI_Support
-Register to MPI a StarPU data handle with the given rank and given communicator. No tag will be defined.
-It also automatically clears the MPI communication cache when unregistering the data.
+Symbol kept for backward compatibility. Calling function starpu_mpi_data_set_tag
 
-\fn int starpu_data_set_rank(starpu_data_handle_t handle, int rank)
+\int starpu_mpi_data_set_rank(starpu_data_handle_t handle, int rank)
 \ingroup API_MPI_Support
 Register to MPI a StarPU data handle with the given rank and the MPI communicator MPI_COMM_WORLD. No tag will be defined.
 It also automatically clears the MPI communication cache when unregistering the data.
 
+\def starpu_data_set_rank
+\ingroup API_MPI_Support
+Symbol kept for backward compatibility. Calling function starpu_mpi_data_set_rank
+
 \fn int starpu_mpi_data_get_rank(starpu_data_handle_t handle)
 \ingroup API_MPI_Support
 Return the rank of the given data.