From cba504ac210e6a187898eb3241b6ce63c76694f9 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Fri, 11 Dec 2015 18:20:04 +0100 Subject: [PATCH] added comment to explain list_lookup() --- include/list.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/list.h b/include/list.h index 2edf38dfb..6f44ee01d 100644 --- a/include/list.h +++ b/include/list.h @@ -63,6 +63,13 @@ void list_push(struct list *l, void *p); void list_remove(struct list *l, void *p); /** Search the list for an element whose first element is a character array which matches name. + * + * List elements should be of the following form: + * + * struct obj { + * char *name; + * // more members + * } * * @see Only possible because of ยง1424 of http://c0x.coding-guidelines.com/6.7.2.1.html */