From 0d32b44a3762cd8861505c031e054cbca8e80bb4 Mon Sep 17 00:00:00 2001 From: Bart Polot Date: Wed, 19 Oct 2011 17:40:14 +0000 Subject: [PATCH] Updated doxygen --- src/mesh/mesh_tunnel_tree.c | 2 ++ src/mesh/mesh_tunnel_tree.h | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) 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. -- 2.25.1