Update all header guards.

[tinc] / src / list.h

diff --git a/src/list.h b/src/list.h
index 4a86316..489c8d1 100644 (file)
--- a/src/list.h
+++ b/src/list.h
@@ -1,7 +1,10 @@
+#ifndef TINC_LIST_H
+#define TINC_LIST_H
+
 /*
     list.h -- header file for list.c
     Copyright (C) 2000-2005 Ivo Timmermans
-                  2000-2006 Guus Sliepen <guus@tinc-vpn.org>
+                  2000-2012 Guus Sliepen <guus@tinc-vpn.org>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -18,9 +21,6 @@
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef __TINC_LIST_H__
-#define __TINC_LIST_H__
-
 typedef struct list_node_t {
        struct list_node_t *prev;
        struct list_node_t *next;
@@ -79,6 +79,12 @@ extern void list_delete_list(list_t *);
 extern void list_foreach(list_t *, list_action_t);
 extern void list_foreach_node(list_t *, list_action_node_t);
 
+/*
+   Iterates over a list.
+
+   CAUTION: while this construct supports deleting the current item,
+   it does *not* support deleting *other* nodes while iterating on the list.
+ */
 #define list_each(type, item, list) (type *item = (type *)1; item; item = NULL) for(list_node_t *node = (list)->head, *next; item = node ? node->data : NULL, next = node ? node->next : NULL, node; node = next)
 
-#endif                                                 /* __TINC_LIST_H__ */
+#endif