comments about struct list

1 files changed, 5 insertions, 0 deletions

diff --git a/lib/linklist.h b/lib/linklist.h
index ace6dee3..331135fe 100644
--- a/lib/linklist.h
+++ b/lib/linklist.h
@@ -36,7 +36,12 @@ struct list
 {
   struct listnode *head;
   struct listnode *tail;
+  /* invariant: count is the number of listnodes in the list */
   unsigned int count;
+  /*
+   * Returns -1 if val1 < val2, 0 if equal?, 1 if val1 > val2.
+   * Used as definition of sorted for listnode_add_sort
+   */
   int (*cmp) (void *val1, void *val2);
   void (*del) (void *val);
 };