summaryrefslogtreecommitdiffhomepage
path: root/docs/cqueue_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-24 14:29:44 +0100
committerTyge Løvset <[email protected]>2021-03-24 14:29:44 +0100
commitb1b19bc2e5a2732e59583184bfa18a34052d5ae1 (patch)
treee800bc0645b4de5b2116c223e99aa23fd79e66ce /docs/cqueue_api.md
parentc96dc0a43037dd14cd0e2539c988a343d99cc728 (diff)
downloadSTC-modified-b1b19bc2e5a2732e59583184bfa18a34052d5ae1.tar.gz
STC-modified-b1b19bc2e5a2732e59583184bfa18a34052d5ae1.zip
Cleanup in documentation.
Diffstat (limited to 'docs/cqueue_api.md')
-rw-r--r--docs/cqueue_api.md31
1 files changed, 16 insertions, 15 deletions
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index d1f889f0..b1ce475a 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -19,7 +19,7 @@ a **cdeq_X** or **clist_X** type as underlying implementation, given as `ctype`.
All cqueue definitions and prototypes are available by including a single header file.
```c
-#include "stc/cqueue.h" /* includes default underlying implementation header cdeq.h */
+#include <stc/cqueue.h> /* includes default underlying implementation header cdeq.h */
```
## Methods
@@ -61,26 +61,26 @@ cqueue_X_value_t cqueue_X_value_clone(cqueue_X_value_t val);
## Examples
```c
+#include <stc/cqueue.h>
#include <stdio.h>
-#include "stc/cqueue.h"
using_cdeq(i, int);
using_cqueue(i, cdeq_i);
int main() {
- cqueue_i queue = cqueue_i_init();
+ cqueue_i Q = cqueue_i_init();
// push() and pop() a few.
c_forrange (i, 20)
- cqueue_i_push(&queue, i);
+ cqueue_i_push(&Q, i);
c_forrange (5)
- cqueue_i_pop(&queue);
+ cqueue_i_pop(&Q);
- c_foreach (i, cqueue_i, queue)
+ c_foreach (i, cqueue_i, Q)
printf(" %d", *i.ref);
- cqueue_i_del(&queue);
+ cqueue_i_del(&Q);
}
```
Output:
@@ -88,28 +88,29 @@ Output:
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
```
### Example 2
+Use clist as underlying cqueue implementation.
```c
+#include <stc/cqueue.h>
+#include <stc/clist.h>
#include <stdio.h>
-#include "stc/cqueue.h"
-#include "stc/clist.h"
-using_cdeq(i, int);
+using_clist(i, int);
using_cqueue(i, clist_i);
int main() {
- cqueue_i queue = cqueue_i_init();
+ cqueue_i Q = cqueue_i_init();
// push() and pop() a few.
c_forrange (i, 20)
- cqueue_i_push(&queue, i);
+ cqueue_i_push(&Q, i);
c_forrange (5)
- cqueue_i_pop(&queue);
+ cqueue_i_pop(&Q);
- c_foreach (i, cqueue_i, queue)
+ c_foreach (i, cqueue_i, Q)
printf(" %d", *i.ref);
- cqueue_i_del(&queue);
+ cqueue_i_del(&Q);
}
```
Output: