summaryrefslogtreecommitdiff
path: root/doc/CK_ARRAY_FOREACH
diff options
context:
space:
mode:
Diffstat (limited to 'doc/CK_ARRAY_FOREACH')
-rw-r--r--doc/CK_ARRAY_FOREACH79
1 files changed, 0 insertions, 79 deletions
diff --git a/doc/CK_ARRAY_FOREACH b/doc/CK_ARRAY_FOREACH
deleted file mode 100644
index d85b767c34ea..000000000000
--- a/doc/CK_ARRAY_FOREACH
+++ /dev/null
@@ -1,79 +0,0 @@
-.\"
-.\" Copyright 2013 Samy Al Bahra.
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\"
-.Dd October 18, 2013
-.Dt CK_ARRAY_FOREACH 3
-.Sh NAME
-.Nm CK_ARRAY_FOREACH
-.Nd iterate through an array
-.Sh LIBRARY
-Concurrency Kit (libck, \-lck)
-.Sh SYNOPSIS
-.In ck_array.h
-.Ft bool
-.Fn CK_ARRAY_FOREACH "ck_array_t *array" "ck_array_iterator_t *iterator" "void **b"
-.Sh DESCRIPTION
-The
-.Fn CK_ARRAY_FOREACH 3
-macro iterates through the array pointed to by
-.Fa array .
-A pointer to an iterator object must be specified by
-.Fa iterator
-and
-.Fa b
-must point to a void pointer.
-.Sh EXAMPLE
-.Bd -literal -offset indent
-#include <ck_array.h>
-
-/* Assume this was already previously initialized. */
-ck_array_t array;
-
-void
-example(void)
-{
- ck_array_iterator_t iterator;
- void *pointer;
-
- CK_ARRAY_FOREACH(&array, &iterator, &pointer) {
- do_something(pointer);
- }
-}
-.Ed
-.Sh RETURN VALUES
-This macro has no return value.
-.Sh SEE ALSO
-.Xr ck_array_init 3 ,
-.Xr ck_array_commit 3 ,
-.Xr ck_array_put 3 ,
-.Xr ck_array_put_unique 3 ,
-.Xr ck_array_remove 3 ,
-.Xr ck_array_deinit 3
-.Xr ck_array_length 3 ,
-.Xr ck_array_buffer 3 ,
-.Xr ck_array_initialized 3
-.Pp
-Additional information available at http://concurrencykit.org/