documentation helps

diff --git a/src/include/heap.h b/src/include/heap.h
index 3ccde24bd515b08b3915ca78019dc1f2333866ac..788030e929415b0368ee2e7637ca25ca1fd53719 100644 (file)
--- 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;