소스 검색

doc: add missing return types for functions

Nathalie Furmento 8 년 전
부모
커밋
0005967a7d

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

@@ -160,7 +160,7 @@ SCC implementation of a codelet.
 \ingroup API_Codelet_And_Tasks
 MIC kernel for a codelet
 
-\typedef *starpu_scc_kernel_t
+\typedef starpu_scc_kernel_t
 \ingroup API_Codelet_And_Tasks
 SCC kernel for a codelet
 

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

@@ -1,7 +1,7 @@
 /*
  * This file is part of the StarPU Handbook.
  * Copyright (C) 2009--2011  Universit@'e de Bordeaux
- * Copyright (C) 2010, 2011, 2012, 2013, 2014  CNRS
+ * Copyright (C) 2010, 2011, 2012, 2013, 2014, 2016  CNRS
  * Copyright (C) 2011, 2012 INRIA
  * See the file version.doxy for copying conditions.
  */
@@ -18,7 +18,7 @@ task that access it in write mode, dependencies will be added between
 the two first tasks and the third one. Implicit data dependencies are
 also inserted in the case of data accesses from the application.
 
-\fn starpu_data_set_default_sequential_consistency_flag(unsigned flag)
+\fn void starpu_data_set_default_sequential_consistency_flag(unsigned flag)
 \ingroup API_Implicit_Data_Dependencies
 Set the default sequential consistency flag. If a non-zero
 value is passed, a sequential data consistency will be enforced for

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

@@ -8,7 +8,7 @@
 
 /*! \defgroup API_Insert_Task Insert_Task
 
-\fn starpu_insert_task(struct starpu_codelet *cl, ...)
+\fn int starpu_insert_task(struct starpu_codelet *cl, ...)
 \ingroup API_Insert_Task
 This function does the same as the function starpu_task_insert(). It has been kept to avoid breaking old codes.
 

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

@@ -305,7 +305,7 @@ Return the tag of the given data.
 Return the tag of the given data.
 Symbol kept for backward compatibility. Calling function starpu_mpi_data_get_tag
 
-\fn starpu_mpi_data_migrate(MPI_Comm comm, starpu_data_handle_t handle, int new_rank)
+\fn void starpu_mpi_data_migrate(MPI_Comm comm, starpu_data_handle_t handle, int new_rank)
 \ingroup API_MPI_Support
 Migrate the data onto the \p new_rank MPI node. This means both transferring
 the data to node \p new_rank if it hasn't been transferred already, and setting

+ 12 - 12
doc/doxygen/chapters/api/threads.doxy

@@ -253,7 +253,7 @@ the key.
 This function changes the value associated with \p key in the calling
 thread, storing the given \p pointer instead.
 
-\fn  *starpu_pthread_getspecific(starpu_pthread_key_t key)
+\fn void *starpu_pthread_getspecific(starpu_pthread_key_t key)
 \ingroup API_Threads
 This function returns the value associated with \p key on success, and
 NULL on error.
@@ -262,25 +262,25 @@ NULL on error.
 \ingroup API_Threads
 This macro initializes the condition variable given in parameter.
 
-\fn starpu_pthread_cond_init(starpu_pthread_cond_t *cond, starpu_pthread_condattr_t *cond_attr)
+\fn int starpu_pthread_cond_init(starpu_pthread_cond_t *cond, starpu_pthread_condattr_t *cond_attr)
 \ingroup API_Threads
 This function initializes the condition variable \p cond, using the
 condition attributes specified in \p cond_attr, or default attributes
 if \p cond_attr is NULL.
 
-\fn starpu_pthread_cond_signal(starpu_pthread_cond_t *cond)
+\fn int starpu_pthread_cond_signal(starpu_pthread_cond_t *cond)
 \ingroup API_Threads
 This function restarts one of the threads that are waiting on the
 condition variable \p cond. If no threads are waiting on \p cond,
 nothing happens. If several threads are waiting on \p cond, exactly
 one is restarted, but it not specified which.
 
-\fn starpu_pthread_cond_broadcast(starpu_pthread_cond_t *cond)
+\fn int starpu_pthread_cond_broadcast(starpu_pthread_cond_t *cond)
 \ingroup API_Threads
 This function restarts all the threads that are waiting on the
 condition variable \p cond. Nothing happens if no threads are waiting on cond.
 
-\fn starpu_pthread_cond_wait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex)
+\fn int starpu_pthread_cond_wait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex)
 \ingroup API_Threads
 This function atomically unlocks the mutex (as per
 starpu_pthread_mutex_unlock()) and waits for the condition variable \p cond
@@ -293,27 +293,27 @@ function re-acquires mutex (as per starpu_pthread_mutex_lock()).
 This function also produces trace when the configure option
 \ref enable-fxt-lock "--enable-fxt-lock" is enabled.
 
-\fn starpu_pthread_cond_timedwait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex, const struct timespec *abstime)
+\fn int starpu_pthread_cond_timedwait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex, const struct timespec *abstime)
 \ingroup API_Threads
 This function atomically unlocks \p mutex and waits on \p cond, as
 starpu_pthread_cond_wait() does, but it also bounds the duration of
 the wait.
 
-\fn starpu_pthread_cond_destroy(starpu_pthread_cond_t *cond)
+\fn int starpu_pthread_cond_destroy(starpu_pthread_cond_t *cond)
 \ingroup API_Threads
 This function destroys a condition variable, freeing the resources it
 might hold. No threads must be waiting on the condition variable on
 entrance to the function.
 
-\fn starpu_pthread_rwlock_init(starpu_pthread_rwlock_t *rwlock, const starpu_pthread_rwlockattr_t *attr)
+\fn int starpu_pthread_rwlock_init(starpu_pthread_rwlock_t *rwlock, const starpu_pthread_rwlockattr_t *attr)
 \ingroup API_Threads
 This function is the same as starpu_pthread_mutex_init().
 
-\fn starpu_pthread_rwlock_destroy(starpu_pthread_rwlock_t *rwlock)
+\fn int starpu_pthread_rwlock_destroy(starpu_pthread_rwlock_t *rwlock)
 \ingroup API_Threads
 This function is the same as starpu_pthread_mutex_destroy().
 
-\fn starpu_pthread_rwlock_rdlock(starpu_pthread_rwlock_t *rwlock)
+\fn int starpu_pthread_rwlock_rdlock(starpu_pthread_rwlock_t *rwlock)
 \ingroup API_Threads
 This function is the same as starpu_pthread_mutex_lock().
 
@@ -321,7 +321,7 @@ This function is the same as starpu_pthread_mutex_lock().
 \ingroup API_Threads
 todo
 
-\fn starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock)
+\fn int starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock)
 \ingroup API_Threads
 This function is the same as starpu_pthread_mutex_lock().
 
@@ -329,7 +329,7 @@ This function is the same as starpu_pthread_mutex_lock().
 \ingroup API_Threads
 todo
 
-\fn starpu_pthread_rwlock_unlock(starpu_pthread_rwlock_t *rwlock)
+\fn int starpu_pthread_rwlock_unlock(starpu_pthread_rwlock_t *rwlock)
 \ingroup API_Threads
 This function is the same as starpu_pthread_mutex_unlock().