Browse Source

Doc: documentation for the "can_execute" field of the codelet structure.

Cyril Roelandt 13 years ago
parent
commit
097ddaffad
1 changed files with 3 additions and 1 deletions
  1. 3 1
      doc/chapters/basic-api.texi

+ 3 - 1
doc/chapters/basic-api.texi

@@ -1062,7 +1062,9 @@ unset, its value will be automatically set based on the availability
 of the @code{XXX_funcs} fields defined below.
 
 @item @code{can_execute} (optional)
-todo
+Function prototype : 
+@code{int (*can_execute)(unsigned workerid, struct starpu_task *task, unsigned nimpl)}.
+Returns 1 if the worker designated by @var{workerid} can execute the @var{nimpl}th implementation of the given@var{task}, 0 otherwise.
 
 @item @code{type}
 @code{enum starpu_codelet_type}