Skip to content

Commit 53be630

Browse files
committed
Expand documentation of equeue
1 parent dc5b9fb commit 53be630

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

events/equeue.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ typedef struct equeue {
9393
//
9494
// If the event queue creation fails, equeue_create returns a negative,
9595
// platform-specific error code.
96+
//
97+
// If queues are chained, it is needed to unchain them first, before calling destroy,
98+
// or call the destroy function on queues in order that chained queues are destroyed first.
9699
int equeue_create(equeue_t *queue, size_t size);
97100
int equeue_create_inplace(equeue_t *queue, size_t size, void *buffer);
98101
void equeue_destroy(equeue_t *queue);

0 commit comments

Comments
 (0)