Browse Source

doc: add missing documentation

Nathalie Furmento 11 years ago
parent
commit
bba5bd817d

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

@@ -1,7 +1,7 @@
 /*
  * This file is part of the StarPU Handbook.
  * Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
- * Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
+ * Copyright (C) 2010, 2011, 2012, 2013, 2014  Centre National de la Recherche Scientifique
  * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
  * See the file version.doxy for copying conditions.
  */
@@ -192,6 +192,10 @@ accessed in the mode ::STARPU_REDUX. Per-worker buffers will be initialized with
 the codelet \p init_cl, and reduction between per-worker buffers will be
 done with the codelet \p redux_cl.
 
+\fn struct starpu_data_interface_ops* starpu_data_get_interface_ops(starpu_data_handle_t handle)
+\ingroup API_Data_Management
+todo
+
 @name Access registered data from the application
 \ingroup API_Data_Management
 

+ 9 - 1
doc/doxygen/chapters/api/fxt_support.doxy

@@ -1,7 +1,7 @@
 /*
  * This file is part of the StarPU Handbook.
  * Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
- * Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
+ * Copyright (C) 2010, 2011, 2012, 2013, 2014  Centre National de la Recherche Scientifique
  * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
  * See the file version.doxy for copying conditions.
  */
@@ -77,5 +77,13 @@ starpu_shutdown(). starpu_fxt_stop_profiling() can however be used to
 stop it earlier. starpu_fxt_start_profiling() can then be called to
 start recording it again, etc.
 
+\fn void starpu_fxt_write_data_trace(char *filename_in)
+\ingroup API_FxT_Support
+todo
+
+\fn void starpu_fxt_trace_user_event(unsigned long code)
+\ingroup API_FxT_Support
+Add an event in the execution trace if FxT is enabled.
+
 */
 

+ 5 - 1
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 1
- * Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
+ * Copyright (C) 2010, 2011, 2012, 2013, 2014  Centre National de la Recherche Scientifique
  * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
  * See the file version.doxy for copying conditions.
  */
@@ -39,4 +39,8 @@ 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().
 
+\fn unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle)
+\ingroup API_Implicit_Data_Dependencies
+Get the data consistency mode associated to the data handle \p handle
+
 */

+ 10 - 0
doc/doxygen/chapters/api/threads.doxy

@@ -140,6 +140,12 @@ terminate.  If that thread has already terminated, then the function
 returns immediately. The thread specified by \p thread must be
 joinable.
 
+\fn int starpu_pthread_exit(void *retval)
+\ingroup API_Threads
+This function terminates the calling thread and returns a value via
+\p retval that (if the thread is joinable) is available to another thread
+in the same process that calls starpu_pthread_join().
+
 \fn int starpu_pthread_attr_init(starpu_pthread_attr_t *attr)
 \ingroup API_Threads
 This function initializes the thread attributes object pointed to by
@@ -311,6 +317,10 @@ This function is the same as starpu_pthread_mutex_destroy().
 \ingroup API_Threads
 This function is the same as starpu_pthread_mutex_lock().
 
+\fn int starpu_pthread_rwlock_tryrdlock(starpu_pthread_rwlock_t *rwlock)
+\ingroup API_Threads
+todo
+
 \fn starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock)
 \ingroup API_Threads
 This function is the same as starpu_pthread_mutex_lock().