- document tunnel internal API

- change iterator parameter order

1 files changed, 30 insertions, 2 deletions

diff --git a/src/mesh/gnunet-service-mesh_tunnel.c b/src/mesh/gnunet-service-mesh_tunnel.c
index 30d3408e9..e5ca08828 100644
--- a/src/mesh/gnunet-service-mesh_tunnel.c
+++ b/src/mesh/gnunet-service-mesh_tunnel.c
@@ -2631,7 +2631,7 @@ GMT_2s (const struct MeshTunnel3 *t)
 
 
 /**
- * Log all possible info about the tunnel state.
+ * Log all possible info about the tunnel state to stderr.
  *
  * @param t Tunnel to debug.
  */
@@ -2671,18 +2671,38 @@ GMT_debug (const struct MeshTunnel3 *t)
 }
 
 
+/**
+ * Iterate all tunnels.
+ *
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
-GMT_iterate_all (void *cls, GNUNET_CONTAINER_PeerMapIterator iter)
+GMT_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls)
 {
   GNUNET_CONTAINER_multipeermap_iterate (tunnels, iter, cls);
 }
 
+
+/**
+ * Count all tunnels.
+ *
+ * @return Number of tunnels to remote peers kept by this peer.
+ */
 unsigned int
 GMT_count_all (void)
 {
   return GNUNET_CONTAINER_multipeermap_size (tunnels);
 }
 
+
+/**
+ * Iterate all connections of a tunnel.
+ *
+ * @param t Tunnel whose connections to iterate.
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
 GMT_iterate_connections (struct MeshTunnel3 *t, GMT_conn_iter iter, void *cls)
 {
@@ -2692,6 +2712,14 @@ GMT_iterate_connections (struct MeshTunnel3 *t, GMT_conn_iter iter, void *cls)
     iter (cls, ct->c);
 }
 
+
+/**
+ * Iterate all channels of a tunnel.
+ *
+ * @param t Tunnel whose channels to iterate.
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
 GMT_iterate_channels (struct MeshTunnel3 *t, GMT_chan_iter iter, void *cls)
 {