add missing documentation

doc/doxygen/chapters/api/insert_task.doxy

@@ -8,9 +8,9 @@
 
 /*! \defgroup API_Insert_Task Insert_Task
 
-\def starpu_insert_task
+\fn starpu_insert_task(struct starpu_codelet *cl, ...)
 \ingroup API_Insert_Task
-Convenience macro for the function starpu_task_insert() which used to be called starpu_insert_task.
+This function does the same as the function starpu_task_insert(). It has been kept to avoid breaking old codes.
 
 \fn int starpu_task_insert(struct starpu_codelet *cl, ...)
 \ingroup API_Insert_Task

doc/doxygen/chapters/api/misc_helpers.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.
  */
@@ -32,5 +32,22 @@ until the function has been executed on every appropriate processing
 units, so that it may not be called from a callback function for
 instance.
 
+\fn void starpu_execute_on_each_worker_ex(void (*func)(void *), void *arg, uint32_t where, const char *name)
+\ingroup API_Miscellaneous_Helpers
+Same as starpu_execute_on_each_worker(), except that the task name is
+specified in the argument \p name.
+
+\fn void starpu_execute_on_specific_workers(void (*func)(void*), void * arg, unsigned num_workers, unsigned * workers, const char * name);
+\ingroup API_Miscellaneous_Helpers
+Call \p func(\p arg) on every worker in the \p workers array. \p
+num_workers indicates the number of workers in this array.  This
+function is synchronous, but the different workers may execute the
+function in parallel.
+
+\fn double starpu_timing_now(void)
+\ingroup API_Miscellaneous_Helpers
+Return the current date in micro-seconds.
+
+
 */
 

doc/doxygen/chapters/api/mpi.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.
  */
@@ -163,6 +163,14 @@ source using the n-th message tag of the array \p mpi_tag within the
 n-th communicator of the array \p comm. On completion of the all the
 requests, \p tag is unlocked.
 
+\fn int starpu_mpi_get_communication_tag(void)
+\ingroup API_MPI_Support
+todo
+
+\fn void starpu_mpi_set_communication_tag(int tag)
+\ingroup API_MPI_Support
+todo
+
 @name Communication Cache
 \ingroup API_MPI_Support
 
@@ -214,9 +222,9 @@ this macro is used when calling starpu_mpi_task_insert(), and must be
 followed by a data handle to specify that the node owning the given
 data will execute the codelet.
 
-\def starpu_mpi_insert_task
+\fn int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet, ...)
 \ingroup API_MPI_Support
-Convenience macro for the function starpu_mpi_task_insert() which used to be called starpu_mpi_insert_task.
+This function does the same as the function starpu_mpi_task_insert(). It has been kept to avoid breaking old codes.
 
 \fn int starpu_mpi_task_insert(MPI_Comm comm, struct starpu_codelet *codelet, ...)
 \ingroup API_MPI_Support

doc/doxygen/chapters/api/performance_model.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.
  */
@@ -207,6 +207,14 @@ in bytes
 \var starpu_perfmodel_history_entry::flops
 Provided by the application
 
+\fn void starpu_perfmodel_init(struct starpu_perfmodel *model)
+\ingroup API_Performance_Model
+todo
+
+\fn void starpu_perfmodel_init_with_file(FILE*f, struct starpu_perfmodel *model)
+\ingroup API_Performance_Model
+todo
+
 \fn int starpu_perfmodel_load_symbol(const char *symbol, struct starpu_perfmodel *model)
 \ingroup API_Performance_Model
 loads a given performance model. The model structure has to be
@@ -223,6 +231,10 @@ through the function starpu_perfmodel_load_symbol()
 \ingroup API_Performance_Model
 returns the path to the debugging information for the performance model.
 
+\fn char* starpu_perfmodel_get_archtype_name(enum starpu_worker_archtype archtype)
+\ingroup API_Performance_Model
+todo
+
 \fn void starpu_perfmodel_get_arch_name(struct starpu_perfmodel_arch *arch, char *archname, size_t maxlen, unsigned nimpl)
 \ingroup API_Performance_Model
 returns the architecture name for \p arch
@@ -276,4 +288,8 @@ Return the latency of data transfer between two memory nodes
 \ingroup API_Performance_Model
 Return the estimated time to transfer a given size between two memory nodes.
 
+\fn double starpu_permodel_history_based_expected_perf(struct starpu_perfmodel *model, struct starpu_perfmodel_arch* arch, uint32_t footprint)
+\ingroup API_Performance_Model
+todo
+
 */

doc/doxygen/chapters/api/scheduling_contexts.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.
  */
@@ -214,6 +214,14 @@ policy of the given scheduler context.
 Returns the current maximum priority level supported by the scheduling
 policy of the given scheduler context.
 
+\fn int starpu_sched_ctx_min_priority_is_set(unsigned sched_ctx_id)
+\ingroup API_Scheduling_Contexts
+todo
+
+\fn int starpu_sched_ctx_max_priority_is_set(unsigned sched_ctx_id)
+\ingroup API_Scheduling_Contexts
+todo
+
 @name Scheduling Context Worker Collection
 \ingroup API_Scheduling_Contexts
 
@@ -264,4 +272,12 @@ assigned to.
 \ingroup API_Scheduling_Contexts
 execute any parallel code on the workers of the sched_ctx (workers are blocked)
 
+\fn int starpu_sched_ctx_get_nready_tasks(unsigned sched_ctx_id)
+\ingroup API_Scheduling_Contexts
+todo
+
+\fn double starpu_sched_ctx_get_nready_flops(unsigned sched_ctx_id)
+\ingroup API_Scheduling_Contexts
+todo
+
 */

doc/doxygen/chapters/api/scheduling_policy.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.
  */
@@ -126,10 +126,6 @@ Check if the worker specified by workerid can execute the codelet.
 Schedulers need to call it before assigning a task to a worker,
 otherwise the task may fail to execute.
 
-\fn double starpu_timing_now(void)
-\ingroup API_Scheduling_Policy
-Return the current date in micro-seconds.
-
 \fn uint32_t starpu_task_footprint(struct starpu_perfmodel *model, struct starpu_task *task, struct starpu_perfmodel_arch *arch, unsigned nimpl)
 \ingroup API_Scheduling_Policy
 Returns the footprint for a given task

include/starpu_util.h

@@ -1,7 +1,7 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  * Copyright (C) 2010-2013  Université 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
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -254,18 +254,12 @@ void starpu_trace_user_event(unsigned long code);
 
 void starpu_execute_on_each_worker(void (*func)(void *), void *arg, uint32_t where);
 
-/* Same as starpu_execute_on_each_worker, except that the task name is specified in the "name" parameter. */
-void starpu_execute_on_each_worker_ex(void (*func)(void *), void *arg, uint32_t where, const char * name);
+void starpu_execute_on_each_worker_ex(void (*func)(void *), void *arg, uint32_t where, const char *name);
 
-/* Call func(arg) on every worker in the "workers" array. "num_workers"
- * indicates the number of workers in this array.  This function is
- * synchronous, but the different workers may execute the function in parallel.
- * */
-void starpu_execute_on_specific_workers(void (*func)(void*), void * arg, unsigned num_workers, unsigned * workers, const char * name);
+void starpu_execute_on_specific_workers(void (*func)(void*), void * arg, unsigned num_workers, unsigned * workers, const char *name);
 
 int starpu_data_cpy(starpu_data_handle_t dst_handle, starpu_data_handle_t src_handle, int asynchronous, void (*callback_func)(void*), void *callback_arg);
 
-/* Return the current date in us */
 double starpu_timing_now(void);
 
 #ifdef __cplusplus