[funds-cvs] r164 - trunk/funds/src/heap

[abaine at common-lisp.net]

Author: abaine
Date: Sun Aug 19 12:27:37 2007
New Revision: 164

Modified:
   trunk/funds/src/heap/heap-remove.lisp
Log:
Documented heap-remove.

Modified: trunk/funds/src/heap/heap-remove.lisp
==============================================================================
--- trunk/funds/src/heap/heap-remove.lisp	(original)
+++ trunk/funds/src/heap/heap-remove.lisp	Sun Aug 19 12:27:37 2007
@@ -17,6 +17,10 @@
 
 (in-package :funds)
 
+(defgeneric heap-remove (heap &key order)
+  (:documentation "The heap that results when first value is removed
+from the given heap."))
+
 (defmethod heap-remove ((heap heap-leaf) &key order)
   (declare (ignore order))
   heap)