Explorar el Código

doc: add missing documentation

Nathalie Furmento hace 10 años
padre
commit
7681b9860b

+ 35 - 1
doc/doxygen/chapters/api/modularized_scheduler.doxy

@@ -2,7 +2,7 @@
  * This file is part of the StarPU Handbook.
  * Copyright (C) 2013        Simon Archipoff
  * Copyright (C) 2009--2011  Universit@'e de Bordeaux
- * Copyright (C) 2014        Centre National de la Recherche Scientifique
+ * Copyright (C) 2014, 2015        Centre National de la Recherche Scientifique
  * Copyright (C) 2013, 2014  INRIA
  * See the file version.doxy for copying conditions.
  */
@@ -235,6 +235,13 @@ The actual scheduler
 @name Flow-control Fifo Component API
 \ingroup API_Modularized_Scheduler
 
+\struct starpu_sched_component_fifo_data
+\ingroup API_Modularized_Scheduler
+\var unsigned starpu_sched_component_fifo_data::ntasks_threshold
+todo
+\var double starpu_sched_component_fifo_data::exp_len_threshold
+todo
+
 \fn struct starpu_sched_component *starpu_sched_component_fifo_create(struct starpu_sched_tree *tree, struct starpu_sched_component_fifo_data *fifo_data)
 \ingroup API_Modularized_Scheduler
 	 Return a struct starpu_sched_component with a fifo. A stable sort is performed according to tasks priorities.
@@ -248,6 +255,13 @@ The actual scheduler
 @name Flow-control Prio Component API
 \ingroup API_Modularized_Scheduler
 
+\struct starpu_sched_component_prio_data
+\ingroup API_Modularized_Scheduler
+\var unsigned starpu_sched_component_prio_data::ntasks_threshold
+todo
+\var double starpu_sched_component_prio_data::exp_len_threshold
+todo
+
 \fn struct starpu_sched_component *starpu_sched_component_prio_create(struct starpu_sched_tree *tree, struct starpu_sched_component_prio_data *prio_data)
 \ingroup API_Modularized_Scheduler
 todo
@@ -307,6 +321,17 @@ todo
 @name Resource-mapping MCT Component API
 \ingroup API_Modularized_Scheduler
 
+\struct starpu_sched_component_mct_data
+\ingroup API_Modularized_Scheduler
+\var double starpu_sched_component_mct_data::alpha
+todo
+\var double starpu_sched_component_mct_data::beta
+todo
+\var double starpu_sched_component_mct_data::_gamma
+todo
+\var double starpu_sched_component_mct_data::idle_power
+todo
+
 \fn struct starpu_sched_component *starpu_sched_component_mct_create(struct starpu_sched_tree *tree, struct starpu_sched_component_mct_data *mct_data)
 \ingroup API_Modularized_Scheduler
 create a component with mct_data paremeters. the mct component doesnt
@@ -341,6 +366,15 @@ todo
 @name Special-purpose Perfmodel_Select Component API
 \ingroup API_Modularized_Scheduler
 
+\struct starpu_sched_component_perfmodel_select_data
+\ingroup API_Modularized_Scheduler
+\var struct starpu_sched_component *starpu_sched_component_perfmodel_select_data::calibrator_component
+todo
+\var struct starpu_sched_component *starpu_sched_component_perfmodel_select_data::no_perfmodel_component
+todo
+\var struct starpu_sched_component *starpu_sched_component_perfmodel_select_data::perfmodel_component
+todo
+
 \fn struct starpu_sched_component *starpu_sched_component_perfmodel_select_create(struct starpu_sched_tree *tree, struct starpu_sched_component_perfmodel_select_data *perfmodel_select_data)
 \ingroup API_Modularized_Scheduler
 todo

+ 3 - 2
doc/doxygen/chapters/api/standard_memory_library.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, 2015  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.
  */
@@ -120,7 +120,8 @@ starpu_memory_allocate() can be followed by several calls to
 starpu_memory_deallocate() to declare the deallocation piece by piece.
 
 \fn void starpu_memory_wait_available(unsigned node, size_t size)
-\ingroup API_Standard_Memory_Library If a memory limit is defined on the given
+\ingroup API_Standard_Memory_Library
+If a memory limit is defined on the given
 node (see Section \ref HowToLimitMemoryPerNode), this will wait for \p size
 bytes to become available on \p node. Of course, since another thread may be
 allocating memory concurrently, this does not necessarily mean that this amount

+ 2 - 1
doc/doxygen/refman.tex

@@ -20,7 +20,7 @@ was last updated on \STARPUUPDATED.\\
 
 Copyright © 2009–2013 Université de Bordeaux\\
 
-Copyright © 2010-2014 Centre National de la Recherche Scientifique\\
+Copyright © 2010-2015 Centre National de la Recherche Scientifique\\
 
 Copyright © 2011, 2012 Institut National de Recherche en Informatique et Automatique\\
 
@@ -269,6 +269,7 @@ Documentation License”.
 \input{starpu__util_8h}
 \input{starpu__worker_8h}
 \input{starpu__mpi_8h}
+\input{starpufft_8h}
 \input{sc__hypervisor_8h}
 \input{sc__hypervisor__config_8h}
 \input{sc__hypervisor__lp_8h}