summaryrefslogtreecommitdiffstats
path: root/src/pqueue.h
diff options
context:
space:
mode:
authorMatthias Schiffer <mschiffer@universe-factory.net>2015-11-10 22:00:15 +0100
committerMatthias Schiffer <mschiffer@universe-factory.net>2015-11-10 22:00:15 +0100
commitbb761bafb89a734fdc98a8e12cfff3b0c16fb0af (patch)
treea517db07dfca3e9734ce4d6d3443377598f8a792 /src/pqueue.h
parentc5aeb0dc4228c6396f35395194e0ec9cc91519c4 (diff)
downloadfastd-bb761bafb89a734fdc98a8e12cfff3b0c16fb0af.tar
fastd-bb761bafb89a734fdc98a8e12cfff3b0c16fb0af.zip
Add lots of missing doxygen comments
Diffstat (limited to 'src/pqueue.h')
-rw-r--r--src/pqueue.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/pqueue.h b/src/pqueue.h
index 126c3ea..8978a84 100644
--- a/src/pqueue.h
+++ b/src/pqueue.h
@@ -34,16 +34,18 @@
#include "types.h"
+/** Element of a priority queue */
struct fastd_pqueue {
- fastd_pqueue_t **pprev;
- fastd_pqueue_t *next;
+ fastd_pqueue_t **pprev; /**< \e next element of the previous element (or \e children of the parent) */
+ fastd_pqueue_t *next; /**< Next sibling in the heap */
- fastd_pqueue_t *children;
+ fastd_pqueue_t *children; /**< Heap children */
- int64_t value;
+ int64_t value; /**< The priority */
};
+/** Checks if an element is currently part of a priority queue */
static inline bool fastd_pqueue_linked(fastd_pqueue_t *elem) {
return elem->pprev;
}