X-Git-Url: https://tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=src%2Fsplay_tree.h;h=3ddf21727a6aec819951c94310e996997a39c607;hp=ca8e1b8f20b55cb9efcb444ac75d7db859634c02;hb=af9ee7ff003fb448b783ccf39347907adc239cb2;hpb=45063953fd3f2c25c7f8cc65860b32a35b3ba80e

diff --git a/src/splay_tree.h b/src/splay_tree.h
index ca8e1b8f..3ddf2172 100644
--- a/src/splay_tree.h
+++ b/src/splay_tree.h
@@ -1,6 +1,6 @@
 /*
     splay_tree.h -- header file for splay_tree.c
-    Copyright (C) 2004-2012 Guus Sliepen <guus@tinc-vpn.org>
+    Copyright (C) 2004-2013 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
@@ -106,6 +106,12 @@ extern splay_node_t *splay_search_closest_greater_node(splay_tree_t *, const voi
 extern void splay_foreach(const splay_tree_t *, splay_action_t);
 extern void splay_foreach_node(const splay_tree_t *, splay_action_t);
 
+/*
+   Iterates over a tree.
+
+   CAUTION: while this construct supports deleting the current item,
+   it does *not* support deleting *other* nodes while iterating on the tree.
+ */
 #define splay_each(type, item, tree) (type *item = (type *)1; item; item = NULL) for(splay_node_t *node = (tree)->head, *next; item = node ? node->data : NULL, next = node ? node->next : NULL, node; node = next)
 
 #endif