Updated doxygen

diff --git a/src/mesh/mesh_tunnel_tree.c b/src/mesh/mesh_tunnel_tree.c
index 50a8d57d4cc6a718370dded20ec5c39a13dae0e0..83ce893dc891df1a4a028b4b332044a53e0b72e9 100644 (file)
--- 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 d0976579fd696ba6c65b35261250b1331607d768..59a60839d43cd922698786d01fd1726bf45e043f 100644 (file)
--- 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.