浏览代码

doc: small fixes

Nathalie Furmento 6 年之前
父节点
当前提交
a10272dd0b
共有 1 个文件被更改,包括 7 次插入8 次删除
  1. 7 8
      doc/doxygen/chapters/api/scheduling_contexts.doxy

+ 7 - 8
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -1,7 +1,7 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  * Copyright (C) 2011-2013,2016-2017                      Inria
- * Copyright (C) 2010-2017                                CNRS
+ * Copyright (C) 2010-2018                                CNRS
  * Copyright (C) 2009-2011,2014,2016                      Université de Bordeaux
  * Copyright (C) 2016                                     Uppsala University
  *
@@ -60,7 +60,7 @@ Create a scheduling context with the given parameters
 tasks submitted to it. The return value represents the identifier of
 the context that has just been created. It will be further used to
 indicate the context the tasks will be submitted to. The return value
-should be at most \ref STARPU_NMAX_SCHED_CTXS.
+should be at most ::STARPU_NMAX_SCHED_CTXS.
 
 The arguments following the name of the scheduling context can be of
 the following types:
@@ -147,13 +147,13 @@ by the application (packed in \p args)
 \ingroup API_Scheduling_Contexts
 Add dynamically the workers in \p workerids_ctx to the
 context \p sched_ctx_id. The last argument cannot be greater than
-\ref STARPU_NMAX_SCHED_CTXS.
+::STARPU_NMAX_SCHED_CTXS.
 
 \fn void starpu_sched_ctx_remove_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id)
 \ingroup API_Scheduling_Contexts
 Remove the workers in \p workerids_ctx from the context
 \p sched_ctx_id. The last argument cannot be greater than
-STARPU_NMAX_SCHED_CTXS.
+::STARPU_NMAX_SCHED_CTXS.
 
 \fn void starpu_sched_ctx_display_workers(unsigned sched_ctx_id, FILE *f)
 \ingroup API_Scheduling_Contexts
@@ -166,8 +166,7 @@ workers to the inheritor scheduling context.
 
 \fn void starpu_sched_ctx_set_inheritor(unsigned sched_ctx_id, unsigned inheritor)
 \ingroup API_Scheduling_Contexts
-Indicate which context whill inherit the resources of this context
-when he will be deleted.
+Indicate that the context \p inheritor will inherit the resources of the context \p sched_ctx_id when \p sched_ctx_id will be deleted.
 
 \fn void starpu_sched_ctx_set_context(unsigned *sched_ctx_id)
 \ingroup API_Scheduling_Contexts
@@ -201,11 +200,11 @@ using it (it is allocated inside the function with the proper size)
 Return the list of workers in the array \p workerids, the returned value is the
 number of workers. This list is provided in raw order, i.e. not sorted by tree or list order,
 and the user should not free the \p workerids table.
-This function is thus much less costly than starpu_sched_ctx_get_workers_list.
+This function is thus much less costly than starpu_sched_ctx_get_workers_list().
 
 \fn unsigned starpu_sched_ctx_get_nworkers(unsigned sched_ctx_id)
 \ingroup API_Scheduling_Contexts
-Return the number of workers managed by the specified contexts
+Return the number of workers managed by the specified context
 (Usually needed to verify if it manages any workers or if it should be
 blocked)