Browse Source

doc: fix function prototypes

Nathalie Furmento 8 years ago
parent
commit
1150f4d6bb

+ 2 - 2
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -132,13 +132,13 @@ Create a context indicating an approximate interval of resources
 Execute the callback whenever the last task of the context finished executing, it is called with the parameters \p sched_ctx and any other parameter needed
 Execute the callback whenever the last task of the context finished executing, it is called with the parameters \p sched_ctx and any other parameter needed
 by the application (packed in \p args)
 by the application (packed in \p args)
 
 
-\fn void starpu_sched_ctx_add_workers(int *workerids_ctx, int nworkers_ctx, unsigned sched_ctx_id)
+\fn void starpu_sched_ctx_add_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id)
 \ingroup API_Scheduling_Contexts
 \ingroup API_Scheduling_Contexts
 Add dynamically the workers in \p workerids_ctx to the
 Add dynamically the workers in \p workerids_ctx to the
 context \p sched_ctx_id. The last argument cannot be greater than
 context \p sched_ctx_id. The last argument cannot be greater than
 \ref STARPU_NMAX_SCHED_CTXS.
 \ref STARPU_NMAX_SCHED_CTXS.
 
 
-\fn void starpu_sched_ctx_remove_workers(int *workerids_ctx, int nworkers_ctx, unsigned sched_ctx_id)
+\fn void starpu_sched_ctx_remove_workers(int *workerids_ctx, unsigned nworkers_ctx, unsigned sched_ctx_id)
 \ingroup API_Scheduling_Contexts
 \ingroup API_Scheduling_Contexts
 Remove the workers in \p workerids_ctx from the context
 Remove the workers in \p workerids_ctx from the context
 \p sched_ctx_id. The last argument cannot be greater than
 \p sched_ctx_id. The last argument cannot be greater than

+ 0 - 6
doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -124,12 +124,6 @@ this should be called by push functions to wake the potential workers that are
 supposed to pick up the tasks which just have been pushed, otherwise they may
 supposed to pick up the tasks which just have been pushed, otherwise they may
 remain sleeping.
 remain sleeping.
 
 
-\fn void starpu_worker_get_job_id(struct starpu_task *task)
-\ingroup API_Scheduling_Policy
-Return the job id of the given task, i.e. a number that uniquely identifies this
-task for the local MPI node, and can be found in the various offline execution
-traces reports.
-
 \fn int starpu_sched_set_min_priority(int min_prio)
 \fn int starpu_sched_set_min_priority(int min_prio)
 \ingroup API_Scheduling_Policy
 \ingroup API_Scheduling_Policy
 TODO: check if this is correct
 TODO: check if this is correct

+ 7 - 7
doc/doxygen/chapters/api/task_lists.doxy

@@ -28,15 +28,15 @@ Push \p task at the front of \p list
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Push \p task at the back of \p list
 Push \p task at the back of \p list
 
 
-\fn struct starpu_task *starpu_task_list_front(struct starpu_task_list *list)
+\fn struct starpu_task *starpu_task_list_front(const struct starpu_task_list *list)
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Get the front of \p list (without removing it)
 Get the front of \p list (without removing it)
 
 
-\fn struct starpu_task *starpu_task_list_back(struct starpu_task_list *list)
+\fn struct starpu_task *starpu_task_list_back(const struct starpu_task_list *list)
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Get the back of \p list (without removing it)
 Get the back of \p list (without removing it)
 
 
-\fn int starpu_task_list_empty(struct starpu_task_list *list)
+\fn int starpu_task_list_empty(const struct starpu_task_list *list)
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Test if \p list is empty
 Test if \p list is empty
 
 
@@ -52,19 +52,19 @@ Remove the element at the front of \p list
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Remove the element at the back of \p list
 Remove the element at the back of \p list
 
 
-\fn struct starpu_task *starpu_task_list_begin(struct starpu_task_list *list)
+\fn struct starpu_task *starpu_task_list_begin(const struct starpu_task_list *list)
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Get the first task of \p list.
 Get the first task of \p list.
 
 
-\fn struct starpu_task *starpu_task_list_end(struct starpu_task_list *list)
+\fn struct starpu_task *starpu_task_list_end(const struct starpu_task_list *list)
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Get the end of \p list.
 Get the end of \p list.
 
 
-\fn struct starpu_task *starpu_task_list_next(struct starpu_task *task)
+\fn struct starpu_task *starpu_task_list_next(const struct starpu_task *task)
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Get the next task of \p list. This is not erase-safe.
 Get the next task of \p list. This is not erase-safe.
 
 
-\fn int starpu_task_list_ismember(struct starpu_task_list *list, struct starpu_task *look)
+\fn int starpu_task_list_ismember(const struct starpu_task_list *list, const struct starpu_task *look)
 \ingroup API_Task_Lists
 \ingroup API_Task_Lists
 Test whether the given task \p look is contained in the \p list.
 Test whether the given task \p look is contained in the \p list.