[1/5] Apply missing fixes from upstream

[elogind.git] / src / basic / prioq.c

diff --git a/src/basic/prioq.c b/src/basic/prioq.c
index 5e567b181d3ae1e6e6d5ded2201e35ae86b82489..d55b348c22f2ec82d13d2dacff33dcc3f808abb7 100644 (file)
--- a/src/basic/prioq.c
+++ b/src/basic/prioq.c
@@ -19,6 +19,16 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 ***/
 
+/*
+ * Priority Queue
+ * The prioq object implements a priority queue. That is, it orders objects by
+ * their priority and allows O(1) access to the object with the highest
+ * priority. Insertion and removal are Θ(log n). Optionally, the caller can
+ * provide a pointer to an index which will be kept up-to-date by the prioq.
+ *
+ * The underlying algorithm used in this implementation is a Heap.
+ */
+
 #include "util.h"
 #include "prioq.h"