From: Christian Grothoff <christian@grothoff.org>
Date: Tue, 17 Jan 2012 16:13:55 +0000 (+0000)
Subject: -document expectations better
X-Git-Tag: initial-import-from-subversion-38251~15258
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=d1b14153c09460420f1a045e7db134b6edb8d15f;p=oweals%2Fgnunet.git

-document expectations better
---

diff --git a/src/include/gnunet_mesh_service.h b/src/include/gnunet_mesh_service.h
index 96e108239..b71c055b5 100644
--- a/src/include/gnunet_mesh_service.h
+++ b/src/include/gnunet_mesh_service.h
@@ -129,7 +129,9 @@ typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
 
 /**
  * Function called whenever an inbound tunnel is destroyed.  Should clean up
- * any associated state.
+ * any associated state.  This function is NOT called if the client has
+ * explicitly asked for the tunnel to be destroyed using
+ * GNUNET_MESH_tunnel_destroy.
  *
  * @param cls closure (set from GNUNET_MESH_connect)
  * @param tunnel connection to the other end (henceforth invalid)