From: Alan T. DeKok <aland@freeradius.org>
Date: Mon, 9 Apr 2018 17:51:33 +0000 (-0400)
Subject: documentation helps
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=40db1108c0669a045c2cbe2d8dde911a9be256a8;p=thirdparty%2Ffreeradius-server.git

documentation helps
---

diff --git a/src/include/heap.h b/src/include/heap.h
index 3ccde24bd51..788030e9294 100644
--- a/src/include/heap.h
+++ b/src/include/heap.h
@@ -32,6 +32,10 @@ RCSIDH(heap_h, "$Id$")
 extern "C" {
 #endif
 
+/*
+ *  Return negative numbers to put 'a' at the top of the heap.
+ *  Return positive numbers to put 'b' at the top of the heap.
+ */
 typedef int (*fr_heap_cmp_t)(void const *a, void const *b);
 
 typedef struct fr_heap_t fr_heap_t;