- doxygen, code formatting

3 files changed, 27 insertions, 5 deletions

diff --git a/src/cadet/gnunet-service-cadet_connection.c b/src/cadet/gnunet-service-cadet_connection.c
index 604b9ad4d..eff147a29 100644
--- a/src/cadet/gnunet-service-cadet_connection.c
+++ b/src/cadet/gnunet-service-cadet_connection.c
@@ -1114,13 +1114,12 @@ connection_unlock_queue (struct CadetConnection *c, int fwd)
 {
   struct CadetPeer *peer;
 
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-              "connection_unlock_queue %s on %s\n",
-              GC_f2s (fwd), GCC_2s (c));
+  LOG (GNUNET_ERROR_TYPE_DEBUG, "connection_unlock_queue %s on %s\n",
+       GC_f2s (fwd), GCC_2s (c));
 
   if (GCC_is_terminal (c, fwd))
   {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
+    LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal, can unlock!\n");
     return;
   }
 
diff --git a/src/cadet/gnunet-service-cadet_peer.c b/src/cadet/gnunet-service-cadet_peer.c
index d1ef331de..fdd79abcd 100644
--- a/src/cadet/gnunet-service-cadet_peer.c
+++ b/src/cadet/gnunet-service-cadet_peer.c
@@ -1428,7 +1428,16 @@ GCP_connection_pop (struct CadetPeer *peer, struct CadetConnection *c)
   return NULL;
 }
 
-
+/**
+ * Unlock a possibly locked queue for a connection.
+ *
+ * If there is a message that can be sent on this connection, call core for it.
+ * Otherwise (if core transmit is already called or there is no sendable
+ * message) do nothing.
+ *
+ * @param peer Peer who keeps the queue.
+ * @param c Connection whose messages to unlock.
+ */
 void
 GCP_queue_unlock (struct CadetPeer *peer, struct CadetConnection *c)
 {
diff --git a/src/cadet/gnunet-service-cadet_peer.h b/src/cadet/gnunet-service-cadet_peer.h
index 240e70526..b7297d101 100644
--- a/src/cadet/gnunet-service-cadet_peer.h
+++ b/src/cadet/gnunet-service-cadet_peer.h
@@ -169,6 +169,10 @@ GCP_queue_cancel (struct CadetPeer *peer, struct CadetConnection *c);
 /**
  * Get the first message for a connection and unqueue it.
  *
+ * If the message was the last in the connection and the destruction flag
+ * was set, the connection will be freed by the continuation called by this
+ * function, and @c c will be INVALID after the call.
+ *
  * @param peer Neighboring peer.
  * @param c Connection.
  *
@@ -177,6 +181,16 @@ GCP_queue_cancel (struct CadetPeer *peer, struct CadetConnection *c);
 struct GNUNET_MessageHeader *
 GCP_connection_pop (struct CadetPeer *peer, struct CadetConnection *c);
 
+/**
+ * Unlock a possibly locked queue for a connection.
+ *
+ * If there is a message that can be sent on this connection, call core for it.
+ * Otherwise (if core transmit is already called or there is no sendable
+ * message) do nothing.
+ *
+ * @param peer Peer who keeps the queue.
+ * @param c Connection whose messages to unlock.
+ */
 void
 GCP_queue_unlock (struct CadetPeer *peer, struct CadetConnection *c);