circleq.3: Fix CIRCLEQ_LOOP_*() return type

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Alejandro Colomar 2021-01-19 22:12:27 +01:00 committed by Michael Kerrisk
parent 67d876899e
commit a3377dcec6
1 changed files with 14 additions and 4 deletions

View File

@ -75,9 +75,9 @@ CIRCLEQ_REMOVE
.BI "struct TYPE *CIRCLEQ_LAST(CIRCLEQ_HEAD *" head );
.BI "struct TYPE *CIRCLEQ_PREV(struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
.BI "struct TYPE *CIRCLEQ_NEXT(struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
.BI "void CIRCLEQ_LOOP_PREV(CIRCLEQ_HEAD *" head ,
.BI "struct TYPE *CIRCLEQ_LOOP_PREV(CIRCLEQ_HEAD *" head ,
.BI " struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
.BI "void CIRCLEQ_LOOP_NEXT(CIRCLEQ_HEAD *" head ,
.BI "struct TYPE *CIRCLEQ_LOOP_NEXT(CIRCLEQ_HEAD *" head ,
.BI " struct TYPE *" elm ", CIRCLEQ_ENTRY " NAME );
.PP
.BI "CIRCLEQ_FOREACH(struct TYPE *" var ", CIRCLEQ_HEAD *" head ,
@ -238,13 +238,23 @@ and zero if the queue contains at least one entry.
.PP
.BR CIRCLEQ_FIRST (),
.BR CIRCLEQ_LAST (),
.BR CIRCLEQ_PREV (),
.BR CIRCLEQ_LOOP_PREV (),
and
.BR CIRCLEQ_NEXT ()
.BR CIRCLEQ_LOOP_NEXT ()
return a pointer to the first, last, previous, or next
.I TYPE
structure, respectively.
.PP
.BR CIRCLEQ_PREV (),
and
.BR CIRCLEQ_NEXT ()
are similar to their
.BR CIRCLEQ_LOOP_* ()
counterparts,
except that if the argument is the first or last element, respectively,
they return
.IR &head .
.PP
.BR CIRCLEQ_HEAD_INITIALIZER ()
returns an initializer that can be assigned to the queue
.IR head .