Browse Source

doc: use @var in deftypefun declarations

Nathalie Furmento 13 years ago
parent
commit
a580ee99e1
2 changed files with 8 additions and 8 deletions
  1. 6 6
      doc/chapters/advanced-api.texi
  2. 2 2
      doc/chapters/advanced-examples.texi

+ 6 - 6
doc/chapters/advanced-api.texi

@@ -98,21 +98,21 @@ The size of the interface data descriptor.
 @end table
 @end deftp
 
-@deftypefun uint32_t starpu_crc32_be_n ({void *}input, size_t n, uint32_t inputcrc)
+@deftypefun uint32_t starpu_crc32_be_n ({void *}@var{input}, size_t @var{n}, uint32_t @var{inputcrc})
 todo: say what it is for
 Compute the CRC of a byte buffer seeded by the inputcrc "current
 state". The return value should be considered as the new "current
 state" for future CRC computation.
 @end deftypefun
 
-@deftypefun uint32_t starpu_crc32_be (uint32_t input, uint32_t inputcrc)
+@deftypefun uint32_t starpu_crc32_be (uint32_t @var{input}, uint32_t @var{inputcrc})
 todo: say what it is for
 Compute the CRC of a 32bit number seeded by the inputcrc "current
 state". The return value should be considered as the new "current
 state" for future CRC computation.
 @end deftypefun
 
-@deftypefun uint32_t starpu_crc32_string ({char *}str, uint32_t inputcrc)
+@deftypefun uint32_t starpu_crc32_string ({char *}@var{str}, uint32_t @var{inputcrc})
 todo: say what it is for
 Compute the CRC of a string seeded by the inputcrc "current state".
 The return value should be considered as the new "current state" for
@@ -279,15 +279,15 @@ todo
 todo
 @end deftypefun
 
-@deftypefun int starpu_combined_worker_assign_workerid (int nworkers, int workerid_array[])
+@deftypefun int starpu_combined_worker_assign_workerid (int @var{nworkers}, int @var{workerid_array[]})
 Register a new combined worker and get its identifier
 @end deftypefun
 
-@deftypefun int starpu_combined_worker_get_description (int workerid, {int *}worker_size, {int **}combined_workerid)
+@deftypefun int starpu_combined_worker_get_description (int @var{workerid}, {int *}@var{worker_size}, {int **}@var{combined_workerid})
 Get the description of a combined worker
 @end deftypefun
 
-@deftypefun int starpu_combined_worker_can_execute_task (unsigned workerid, {struct starpu_task *}task, unsigned nimpl)
+@deftypefun int starpu_combined_worker_can_execute_task (unsigned @var{workerid}, {struct starpu_task *}@var{task}, unsigned @var{nimpl})
 Variant of starpu_worker_can_execute_task compatible with combined workers
 @end deftypefun
 

+ 2 - 2
doc/chapters/advanced-examples.texi

@@ -501,13 +501,13 @@ this macro is used when calling @code{starpu_insert_task}, and must be
 followed by a integer defining a priority level
 @end defmac
 
-@deftypefun void starpu_codelet_pack_args ({char **}arg_buffer, {size_t *}arg_buffer_size, ...)
+@deftypefun void starpu_codelet_pack_args ({char **}@var{arg_buffer}, {size_t *}@var{arg_buffer_size}, ...)
 Pack arguments of type @code{STARPU_VALUE} into a buffer which can be
 given to a codelet and later unpacked with the function
 @code{starpu_codelet_unpack_args} defined below.
 @end deftypefun
 
-@deftypefun void starpu_codelet_unpack_args ({void *}cl_arg, ...)
+@deftypefun void starpu_codelet_unpack_args ({void *}@var{cl_arg}, ...)
 Retrieve the arguments of type @code{STARPU_VALUE} associated to a
 task automatically created using the function
 @code{starpu_insert_task} defined above.