Browse Source

doc/doxygen/chapters/api: fix documentation to be up-to-date with code

Nathalie Furmento 10 years ago
parent
commit
3a0e5739a6

+ 2 - 2
doc/doxygen/chapters/api/codelet_and_tasks.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  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.
  */
@@ -693,7 +693,7 @@ starpu_codelet::modes or the \p i th element of the field
 starpu_codelet::dyn_modes (see \ref
 SettingTheDataHandlesForATask)
 
-\def STARPU_TASK_GET_MODE(codelet, i)
+\def STARPU_TASK_GET_MODE(task, i)
 \ingroup API_Codelet_And_Tasks
 Return the access mode of the \p i th data handle of the given
 task. If the task is defined with a static or dynamic number of

+ 0 - 4
doc/doxygen/chapters/api/modularized_scheduler.doxy

@@ -207,10 +207,6 @@ starpu_sched_component_heft_create parameters
 	 recursively destroy non shared parts of a \p component 's tree
 
 
-\fn starpu_sched_component_available(struct starpu_sched_component *component)
-\ingroup API_Modularized_Scheduler
-	 notify all component's underlying workers that a task is available to pop
-
 \fn int starpu_sched_tree_push_task(struct starpu_task *task)
 \ingroup API_Modularized_Scheduler
 	 compatibility with starpu_sched_policy interface