Browse Source

Add missing docs

Samuel Thibault 5 years ago
parent
commit
680ef90623
3 changed files with 18 additions and 0 deletions
  1. 11 0
      include/starpu_task.h
  2. 4 0
      include/starpu_task_util.h
  3. 3 0
      include/starpu_worker.h

+ 11 - 0
include/starpu_task.h

@@ -1205,8 +1205,19 @@ struct starpu_task
 	void *sched_data;
 };
 
+/**
+   To be used in the starpu_task::type field, for normal application tasks.
+*/
 #define STARPU_TASK_TYPE_NORMAL		0
+
+/**
+   To be used in the starpu_task::type field, for StarPU-internal tasks.
+*/
 #define STARPU_TASK_TYPE_INTERNAL	(1<<0)
+
+/**
+   To be used in the starpu_task::type field, for StarPU-internal data acquisition tasks.
+*/
 #define STARPU_TASK_TYPE_DATA_ACQUIRE	(1<<1)
 
 /**

+ 4 - 0
include/starpu_task_util.h

@@ -170,6 +170,10 @@ extern "C"
 */
 #define STARPU_TAG_ONLY          (20<<STARPU_MODE_SHIFT)
 
+/**
+   Used when calling starpu_task_insert(), must be followed by an unsigned
+   stored in starpu_task::possibly_parallel.
+*/
 #define STARPU_POSSIBLY_PARALLEL    (21<<STARPU_MODE_SHIFT)
 
 /**

+ 3 - 0
include/starpu_worker.h

@@ -40,6 +40,9 @@ extern "C"
    @{
 */
 
+/**
+  Memory node Type
+*/
 enum starpu_node_kind
 {
 	STARPU_UNUSED=0,