Browse Source

include: fix documentation

Nathalie Furmento 4 years ago
parent
commit
64fa4e642b
2 changed files with 13 additions and 7 deletions
  1. 8 1
      include/starpu_task.h
  2. 5 6
      include/starpu_task_util.h

+ 8 - 1
include/starpu_task.h

@@ -670,6 +670,7 @@ struct starpu_task
 	   when using ::STARPU_R and alike.
 	   when using ::STARPU_R and alike.
 	*/
 	*/
 	starpu_data_handle_t handles[STARPU_NMAXBUFS];
 	starpu_data_handle_t handles[STARPU_NMAXBUFS];
+
 	/**
 	/**
 	   Array of Data pointers to the memory node where execution
 	   Array of Data pointers to the memory node where execution
 	   will happen, managed by the DSM.
 	   will happen, managed by the DSM.
@@ -677,6 +678,7 @@ struct starpu_task
 	   This is filled by StarPU.
 	   This is filled by StarPU.
 	*/
 	*/
 	void *interfaces[STARPU_NMAXBUFS];
 	void *interfaces[STARPU_NMAXBUFS];
+
 	/**
 	/**
 	   Used only when starpu_codelet::nbuffers is \ref
 	   Used only when starpu_codelet::nbuffers is \ref
 	   STARPU_VARIABLE_NBUFFERS.
 	   STARPU_VARIABLE_NBUFFERS.
@@ -764,6 +766,9 @@ struct starpu_task
 	   already executing. The callback is passed
 	   already executing. The callback is passed
 	   the value contained in the starpu_task::epilogue_callback_arg field.
 	   the value contained in the starpu_task::epilogue_callback_arg field.
 	   No callback is executed if the field is set to <c>NULL</c>.
 	   No callback is executed if the field is set to <c>NULL</c>.
+
+	   With starpu_task_insert() and alike this can be specified thanks to
+	   ::STARPU_EPILOGUE_CALLBACK followed by the function pointer.
 	*/
 	*/
 	void (*epilogue_callback_func)(void *);
 	void (*epilogue_callback_func)(void *);
 
 
@@ -835,7 +840,8 @@ struct starpu_task
 	*/
 	*/
 	void *prologue_callback_arg;
 	void *prologue_callback_arg;
 
 
-	/** Optional field, the default value is <c>NULL</c>. This is a
+	/**
+	   Optional field, the default value is <c>NULL</c>. This is a
 	   function pointer of prototype <c>void (*f)(void*)</c>
 	   function pointer of prototype <c>void (*f)(void*)</c>
 	   which specifies a possible callback. If this pointer is
 	   which specifies a possible callback. If this pointer is
 	   non-<c>NULL</c>, the callback function is executed on the host
 	   non-<c>NULL</c>, the callback function is executed on the host
@@ -848,6 +854,7 @@ struct starpu_task
 	   ::STARPU_PROLOGUE_CALLBACK_POP followed by the function pointer.
 	   ::STARPU_PROLOGUE_CALLBACK_POP followed by the function pointer.
 	*/
 	*/
 	void (*prologue_callback_pop_func)(void *);
 	void (*prologue_callback_pop_func)(void *);
+
 	/**
 	/**
 	   Optional field, the default value is <c>NULL</c>. This is
 	   Optional field, the default value is <c>NULL</c>. This is
 	   the pointer passed to the prologue_callback_pop function. This
 	   the pointer passed to the prologue_callback_pop function. This

+ 5 - 6
include/starpu_task_util.h

@@ -88,14 +88,15 @@ extern "C"
 #define STARPU_EXECUTE_ON_DATA	 (7<<STARPU_MODE_SHIFT)
 #define STARPU_EXECUTE_ON_DATA	 (7<<STARPU_MODE_SHIFT)
 
 
 /**
 /**
-   Used when calling starpu_task_in_sert(), must be followed by an array of
+   Used when calling starpu_task_insert(), must be followed by an array of
    handles and the number of elements in the array (as int). This is equivalent
    handles and the number of elements in the array (as int). This is equivalent
-   to passing the handles as separate parameters with STARPU_R/W/RW.
+   to passing the handles as separate parameters with ::STARPU_R,
+   ::STARPU_W or ::STARPU_RW.
 */
 */
 #define STARPU_DATA_ARRAY        (8<<STARPU_MODE_SHIFT)
 #define STARPU_DATA_ARRAY        (8<<STARPU_MODE_SHIFT)
 
 
 /**
 /**
-   Used when calling starpu_task_in_sert(), must be followed by an array of
+   Used when calling starpu_task_insert(), must be followed by an array of
    struct starpu_data_descr and the number of elements in the array (as int).
    struct starpu_data_descr and the number of elements in the array (as int).
    This is equivalent to passing the handles with the corresponding modes.
    This is equivalent to passing the handles with the corresponding modes.
 */
 */
@@ -322,8 +323,7 @@ extern "C"
 
 
 /**
 /**
    Used when calling starpu_task_insert() and alike, must be followed
    Used when calling starpu_task_insert() and alike, must be followed
-   by a void* specifying the value to be set in the sched_data field of the
-   task.
+   by a void* specifying the value to be set in starpu_task::sched_data
  */
  */
 #define STARPU_TASK_SCHED_DATA (41<<STARPU_MODE_SHIFT)
 #define STARPU_TASK_SCHED_DATA (41<<STARPU_MODE_SHIFT)
 
 
@@ -375,7 +375,6 @@ int starpu_task_set(struct starpu_task *task, struct starpu_codelet *cl, ...);
 	starpu_task_set((task), (cl), STARPU_TASK_FILE, __FILE__, STARPU_TASK_LINE, __LINE__, ##__VA_ARGS__)
 	starpu_task_set((task), (cl), STARPU_TASK_FILE, __FILE__, STARPU_TASK_LINE, __LINE__, ##__VA_ARGS__)
 #endif
 #endif
 
 
-
 /**
 /**
    Create a task corresponding to \p cl with the following arguments.
    Create a task corresponding to \p cl with the following arguments.
    The argument list must be zero-terminated. The arguments
    The argument list must be zero-terminated. The arguments