From 7ffee8875d10e1d3a52c5f8817112d235bec53bf Mon Sep 17 00:00:00 2001 From: teknomunk Date: Tue, 22 Aug 2023 18:23:39 -0500 Subject: [PATCH] Add tiny amount of documentation --- collection.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/collection.h b/collection.h index 2a3c6d7..886fc69 100644 --- a/collection.h +++ b/collection.h @@ -17,6 +17,14 @@ struct item_type_vtable int size; void (*free)( struct collection it, void* item ); int (*compare)( struct collection it, void* a, void* b ); + /* + Should return: + -1 when a < b + 1 when a > b + 0 when a = b + + Same as strcmp + */ }; struct collection