Browse Source

include/starpu_task.h: add documentation for magic field

Nathalie Furmento 13 years ago
parent
commit
c7b299435f
1 changed files with 6 additions and 0 deletions
  1. 6 0
      include/starpu_task.h

+ 6 - 0
include/starpu_task.h

@@ -192,6 +192,12 @@ struct starpu_task
 	 * by hand (without starpu_task_create), this field should be set to
 	 * by hand (without starpu_task_create), this field should be set to
 	 * NULL. */
 	 * NULL. */
 	void *starpu_private;
 	void *starpu_private;
+
+	/* the magic field is set when initialising the task.
+	 * starpu_task_submit will fail if the field does not have the
+	 * right value. This will hence avoid submitting tasks which
+	 * have not been properly initialised.
+	 */
 	int magic;
 	int magic;
 };
 };