haiwan
/
ck
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix documentation for ck_pr_*_zero functions.

Browse Source 
They were incorrectly documented as providing rvalue.
ck_pring
Samy Al Bahra 11 years ago
parent 2245f28cb3
commit d66fc5de81
3 changed files with 69 additions and 61 deletions
Show Stats Download Patch File Download Diff File

45
doc/ck_pr_dec
Unescape View File

@ -52,40 +52,40 @@ Concurrency Kit (libck, \-lck)
.In ck_pr.h
.Ft void
.Fn ck_pr_dec_ptr "void *target"
.Ft bool
.Fn ck_pr_dec_ptr_zero "void *target"
.Ft void
.Fn ck_pr_dec_ptr_zero "void *target" "bool *z"
.Ft void
.Fn ck_pr_dec_double "double *target"
.Ft bool
.Fn ck_pr_dec_double_zero "double *target"
.Ft void
.Fn ck_pr_dec_double_zero "double *target" "bool *z"
.Ft void
.Fn ck_pr_dec_char "char *target"
.Ft bool
.Fn ck_pr_dec_char_zero "char *target"
.Ft void
.Fn ck_pr_dec_char_zero "char *target" "bool *z"
.Ft void
.Fn ck_pr_dec_uint "unsigned int *target"
.Ft bool
.Fn ck_pr_dec_uint_zero "unsigned int *target"
.Ft void
.Fn ck_pr_dec_uint_zero "unsigned int *target" "bool *z"
.Ft void
.Fn ck_pr_dec_int "int *target"
.Ft bool
.Fn ck_pr_dec_int_zero "int *target"
.Ft void
.Fn ck_pr_dec_int_zero "int *target" "bool *z"
.Ft void
.Fn ck_pr_dec_64 "uint64_t *target"
.Ft bool
.Fn ck_pr_dec_64_zero "uint64_t *target"
.Ft void
.Fn ck_pr_dec_64_zero "uint64_t *target" "bool *z"
.Ft void
.Fn ck_pr_dec_32 "uint32_t *target"
.Ft bool
.Fn ck_pr_dec_32_zero "uint32_t *target"
.Ft void
.Fn ck_pr_dec_32_zero "uint32_t *target" "bool *z"
.Ft void
.Fn ck_pr_dec_16 "uint16_t *target"
.Ft bool
.Fn ck_pr_dec_16_zero "uint16_t *target"
.Ft void
.Fn ck_pr_dec_16_zero "uint16_t *target" "bool *z"
.Ft void
.Fn ck_pr_dec_8 "uint8_t *target"
.Ft bool
.Fn ck_pr_dec_8_zero "uint8_t *target"
.Ft void
.Fn ck_pr_dec_8_zero "uint8_t *target" "bool *z"
.Sh DESCRIPTION
The
.Fn ck_pr_dec 3
@ -93,9 +93,12 @@ family of functions atomically decrement the value pointed to
by
.Fa target .
.Sh RETURN VALUES
The ck_pr_dec_zero family of functions returns true if the result
of the decrement operation was 0. They return
false otherwise.
The ck_pr_dec_zero family of functions set the value pointed to by
.Fa z
to true if the result
of the decrement operation was 0. They set the value pointed to by
.Fa z
to false otherwise.
.Sh SEE ALSO
.Xr ck_pr_fence_load 3 ,
.Xr ck_pr_fence_load_depends 3 ,

43
doc/ck_pr_inc
Unescape View File

@ -52,40 +52,40 @@ Concurrency Kit (libck, \-lck)
.In ck_pr.h
.Ft void
.Fn ck_pr_inc_ptr "void *target"
.Ft bool
.Fn ck_pr_inc_ptr_zero "void *target"
.Ft void
.Fn ck_pr_inc_ptr_zero "void *target" "bool *z"
.Ft void
.Fn ck_pr_inc_double "double *target"
.Ft bool
.Fn ck_pr_inc_double_zero "double *target"
.Ft void
.Fn ck_pr_inc_double_zero "double *target" "bool *z"
.Ft void
.Fn ck_pr_inc_char "char *target"
.Ft bool
.Fn ck_pr_inc_char_zero "char *target"
.Ft void
.Fn ck_pr_inc_char_zero "char *target" "bool *z"
.Ft void
.Fn ck_pr_inc_uint "unsigned int *target"
.Ft bool
.Fn ck_pr_inc_uint_zero "unsigned int *target"
.Ft void
.Fn ck_pr_inc_uint_zero "unsigned int *target" "bool *z"
.Ft void
.Fn ck_pr_inc_int "int *target"
.Ft bool
.Fn ck_pr_inc_int_zero "int *target"
.Ft void
.Fn ck_pr_inc_int_zero "int *target" "bool *z"
.Ft void
.Fn ck_pr_inc_64 "uint64_t *target"
.Ft bool
.Fn ck_pr_inc_64_zero "uint64_t *target"
.Ft void
.Fn ck_pr_inc_64_zero "uint64_t *target" "bool *z"
.Ft void
.Fn ck_pr_inc_32 "uint32_t *target"
.Ft bool
.Fn ck_pr_inc_32_zero "uint32_t *target"
.Ft void
.Fn ck_pr_inc_32_zero "uint32_t *target" "bool *z"
.Ft void
.Fn ck_pr_inc_16 "uint16_t *target"
.Ft bool
.Fn ck_pr_inc_16_zero "uint16_t *target"
.Ft void
.Fn ck_pr_inc_16_zero "uint16_t *target" "bool *z"
.Ft void
.Fn ck_pr_inc_8 "uint8_t *target"
.Ft bool
.Fn ck_pr_inc_8_zero "uint8_t *target"
.Ft void
.Fn ck_pr_inc_8_zero "uint8_t *target" "bool *z"
.Sh DESCRIPTION
The
.Fn ck_pr_inc 3
@ -93,8 +93,11 @@ family of functions atomically increment the value pointed to
by
.Fa target .
.Sh RETURN VALUES
The ck_pr_inc_zero family of functions return true
if the result of the increment operation was 0. The functions return
The ck_pr_inc_zero family of functions set the value pointed to by
.Fa z
to true if the result of the increment operation was 0. The functions set
the value pointed to by
.Fa z
false otherwise.
.Sh SEE ALSO
.Xr ck_pr_fence_load 3 ,

42
doc/ck_pr_neg
Unescape View File

@ -52,40 +52,40 @@ Concurrency Kit (libck, \-lck)
.In ck_pr.h
.Ft void
.Fn ck_pr_neg_ptr "void *target"
.Ft bool
.Fn ck_pr_neg_ptr_zero "void *target"
.Ft void
.Fn ck_pr_neg_ptr_zero "void *target" "bool *z"
.Ft void
.Fn ck_pr_neg_double "double *target"
.Ft bool
.Fn ck_pr_neg_double_zero "double *target"
.Ft void
.Fn ck_pr_neg_double_zero "double *target" "bool *z"
.Ft void
.Fn ck_pr_neg_char "char *target"
.Ft bool
.Fn ck_pr_neg_char_zero "char *target"
.Ft void
.Fn ck_pr_neg_char_zero "char *target" "bool *z"
.Ft void
.Fn ck_pr_neg_uint "unsigned int *target"
.Ft bool
.Fn ck_pr_neg_uint_zero "unsigned int *target"
.Ft void
.Fn ck_pr_neg_uint_zero "unsigned int *target" "bool *z"
.Ft void
.Fn ck_pr_neg_int "int *target"
.Ft bool
.Fn ck_pr_neg_int_zero "int *target"
.Ft void
.Fn ck_pr_neg_int_zero "int *target" "bool *z"
.Ft void
.Fn ck_pr_neg_64 "uint64_t *target"
.Ft bool
.Fn ck_pr_neg_64_zero "uint64_t *target"
.Ft void
.Fn ck_pr_neg_64_zero "uint64_t *target" "bool *z"
.Ft void
.Fn ck_pr_neg_32 "uint32_t *target"
.Ft bool
.Fn ck_pr_neg_32_zero "uint32_t *target"
.Ft void
.Fn ck_pr_neg_32_zero "uint32_t *target" "bool *z"
.Ft void
.Fn ck_pr_neg_16 "uint16_t *target"
.Ft bool
.Fn ck_pr_neg_16_zero "uint16_t *target"
.Ft void
.Fn ck_pr_neg_16_zero "uint16_t *target" "bool *z"
.Ft void
.Fn ck_pr_neg_8 "uint8_t *target"
.Ft bool
.Fn ck_pr_neg_8_zero "uint8_t *target"
.Ft void
.Fn ck_pr_neg_8_zero "uint8_t *target" "bool *z"
.Sh DESCRIPTION
The
.Fn ck_pr_neg 3
@ -93,8 +93,10 @@ family of functions atomically negate the value pointed to
by
.Fa target .
.Sh RETURN VALUES
The ck_pr_neg_zero functions return true if the result
of the negation operation was 0. They return false otherwise.
The ck_pr_neg_zero functions set the value pointed to by
.Fa z
if the result of the negation operation was 0. They set the
pointed to value to false otherwise.
.Sh SEE ALSO
.Xr ck_pr_fence_load 3 ,
.Xr ck_pr_fence_load_depends 3 ,

Write Preview
Loading…
Cancel
Save