Browse Source

doc/doxygen/chapters/api/scheduling_contexts.doxy: fix documentation
for starpu_sched_ctx_get_context()

Nathalie Furmento 11 years ago
parent
commit
cc08400f8b
1 changed files with 3 additions and 1 deletions
  1. 3 1
      doc/doxygen/chapters/api/scheduling_contexts.doxy

+ 3 - 1
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -124,7 +124,9 @@ Set the scheduling context the subsequent tasks will be submitted to
 
 \fn unsigned starpu_sched_ctx_get_context(void)
 \ingroup API_Scheduling_Contexts
-Return the scheduling context the tasks are currently submitted to
+Return the scheduling context the tasks are currently submitted to,
+or ::STARPU_NMAX_SCHED_CTXS if no default context has been defined
+by calling the function starpu_sched_ctx_set_context().
 
 \fn void starpu_sched_ctx_stop_task_submission(void)
 \ingroup API_Scheduling_Contexts