summaryrefslogtreecommitdiff
path: root/src/mesh
diff options
context:
space:
mode:
authorBart Polot <bart@net.in.tum.de>2011-10-19 17:40:14 +0000
committerBart Polot <bart@net.in.tum.de>2011-10-19 17:40:14 +0000
commit0d32b44a3762cd8861505c031e054cbca8e80bb4 (patch)
tree5811ca41555a77b415bcdde4aef5b8122c2401e1 /src/mesh
parent3b88b34d978ad341856b0f31b78e8d4a4c98d52c (diff)
Updated doxygen
Diffstat (limited to 'src/mesh')
-rw-r--r--src/mesh/mesh_tunnel_tree.c2
-rw-r--r--src/mesh/mesh_tunnel_tree.h5
2 files changed, 6 insertions, 1 deletions
diff --git a/src/mesh/mesh_tunnel_tree.c b/src/mesh/mesh_tunnel_tree.c
index 50a8d57d4..83ce893dc 100644
--- a/src/mesh/mesh_tunnel_tree.c
+++ b/src/mesh/mesh_tunnel_tree.c
@@ -678,6 +678,8 @@ tree_notify_connection_broken (struct MeshTunnelTree *t,
/**
* Deletes a peer from a tunnel, liberating all unused resources on the path to
* it. It shouldn't have children, if it has they will be destroyed as well.
+ * If the tree is not local and no longer has any paths, the root node will be
+ * destroyed and marked as NULL.
*
* @param t Tunnel tree to use.
* @param peer Short ID of the peer to remove from the tunnel tree.
diff --git a/src/mesh/mesh_tunnel_tree.h b/src/mesh/mesh_tunnel_tree.h
index d0976579f..59a60839d 100644
--- a/src/mesh/mesh_tunnel_tree.h
+++ b/src/mesh/mesh_tunnel_tree.h
@@ -348,7 +348,10 @@ tree_notify_connection_broken (struct MeshTunnelTree *t,
/**
- * Deletes a peer from a tunnel, marking its children as disconnected.
+ * Deletes a peer from a tunnel, liberating all unused resources on the path to
+ * it. It shouldn't have children, if it has they will be destroyed as well.
+ * If the tree is not local and no longer has any paths, the root node will be
+ * destroyed and marked as NULL.
*
* @param t Tunnel tree to use.
* @param peer Short ID of the peer to remove from the tunnel tree.