Update all header guards.

[tinc] / src / splay_tree.h

diff --git a/src/splay_tree.h b/src/splay_tree.h
index 5848870..d360fc3 100644 (file)
--- a/src/splay_tree.h
+++ b/src/splay_tree.h
@@ -1,3 +1,6 @@
+#ifndef TINC_SPLAY_TREE_H
+#define TINC_SPLAY_TREE_H
+
 /*
     splay_tree.h -- header file for splay_tree.c
     Copyright (C) 2004-2013 Guus Sliepen <guus@tinc-vpn.org>
@@ -17,10 +20,6 @@
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-
-#ifndef __SPLAY_TREE_H__
-#define __SPLAY_TREE_H__
-
 typedef struct splay_node_t {
 
        /* Linked list part */
@@ -106,6 +105,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