Browse Source

doc: fix syntax

Nathalie Furmento 7 years ago
parent
commit
e5d459db83
1 changed files with 12 additions and 12 deletions
  1. 12 12
      doc/doxygen/chapters/api/insert_task.doxy

+ 12 - 12
doc/doxygen/chapters/api/insert_task.doxy

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
  *
- * Copyright (C) 2010-2017                                CNRS
+ * Copyright (C) 2010-2018                                CNRS
  * Copyright (C) 2009-2011,2014-2016,2018                 Université de Bordeaux
  * Copyright (C) 2009-2011,2014-2016,2018                 Université de Bordeaux
  * Copyright (C) 2011-2012                                Inria
  * Copyright (C) 2011-2012                                Inria
  *
  *
@@ -169,18 +169,17 @@ room again with this function, store yet more handles, etc.
 
 
 \fn void starpu_task_insert_data_process_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int arg_type, starpu_data_handle_t handle)
 \fn void starpu_task_insert_data_process_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int arg_type, starpu_data_handle_t handle)
 \ingroup API_Insert_Task
 \ingroup API_Insert_Task
-This stores data handle \p handle into task \p task with mode \p arg_type,
+Store data handle \p handle into task \p task with mode \p arg_type,
 updating \p *allocated_buffers and \p *current_buffer accordingly.
 updating \p *allocated_buffers and \p *current_buffer accordingly.
 
 
 \fn void starpu_task_insert_data_process_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_handles, starpu_data_handle_t *handles)
 \fn void starpu_task_insert_data_process_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_handles, starpu_data_handle_t *handles)
 \ingroup API_Insert_Task
 \ingroup API_Insert_Task
-This stores \p nb_handles data handles \p handles into task \p task, updating \p
+Store \p nb_handles data handles \p handles into task \p task, updating \p
 *allocated_buffers and \p *current_buffer accordingly.
 *allocated_buffers and \p *current_buffer accordingly.
 
 
-
 \fn void starpu_task_insert_data_process_mode_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_descrs, struct starpu_data_descr *descrs);
 \fn void starpu_task_insert_data_process_mode_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_descrs, struct starpu_data_descr *descrs);
 \ingroup API_Insert_Task
 \ingroup API_Insert_Task
-This stores \p nb_descrs data handles described by \p descrs into task \p task,
+Store \p nb_descrs data handles described by \p descrs into task \p task,
 updating \p *allocated_buffers and \p *current_buffer accordingly.
 updating \p *allocated_buffers and \p *current_buffer accordingly.
 
 
 \fn void starpu_codelet_pack_args(void **arg_buffer, size_t *arg_buffer_size, ...)
 \fn void starpu_codelet_pack_args(void **arg_buffer, size_t *arg_buffer_size, ...)
@@ -195,18 +194,19 @@ data, then starpu_codelet_pack_arg_fini().
 
 
 \fn void starpu_codelet_pack_arg_init(struct starpu_codelet_pack_arg_data *state)
 \fn void starpu_codelet_pack_arg_init(struct starpu_codelet_pack_arg_data *state)
 \ingroup API_Insert_Task
 \ingroup API_Insert_Task
-Initiaze struct starpu_codelet_pack_arg before calling starpu_codelet_pack_arg and
-starpu_codelet_pack_arg_fini. This will simply initialize the content of the structure.
+Initialize struct starpu_codelet_pack_arg before calling starpu_codelet_pack_arg() and
+starpu_codelet_pack_arg_fini(). This will simply initialize the content of the structure.
 
 
 \fn void starpu_codelet_pack_arg(struct starpu_codelet_pack_arg_data *state, void *ptr, size_t ptr_size)
 \fn void starpu_codelet_pack_arg(struct starpu_codelet_pack_arg_data *state, void *ptr, size_t ptr_size)
-Pack one argument into struct starpu_codelet_pack_arg state. That structure
-has to be initialized before with starpu_codelet_pack_arg_init, and after all
-starpu_codelet_pack_arg calls performed, starpu_codelet_pack_arg_fini has to be
-used to get the cl_arg and cl_arg_size to be put in the task.
+\ingroup API_Insert_Task
+Pack one argument into struct starpu_codelet_pack_arg \p state. That structure
+has to be initialized before with starpu_codelet_pack_arg_init(), and after all
+starpu_codelet_pack_arg() calls performed, starpu_codelet_pack_arg_fini() has to be
+used to get the \p cl_arg and \p cl_arg_size to be put in the task.
 
 
 \fn void starpu_codelet_pack_arg_fini(struct starpu_codelet_pack_arg_data *state, void **cl_arg, size_t *cl_arg_size)
 \fn void starpu_codelet_pack_arg_fini(struct starpu_codelet_pack_arg_data *state, void **cl_arg, size_t *cl_arg_size)
 \ingroup API_Insert_Task
 \ingroup API_Insert_Task
-Finish packing data, after calling starpu_codelet_pack_arg_init once and starpu_codelet_pack_arg several times.
+Finish packing data, after calling starpu_codelet_pack_arg_init() once and starpu_codelet_pack_arg() several times.
 
 
 \fn void starpu_codelet_unpack_args(void *cl_arg, ...)
 \fn void starpu_codelet_unpack_args(void *cl_arg, ...)
 \ingroup API_Insert_Task
 \ingroup API_Insert_Task