documentation

1 files changed, 38 insertions, 2 deletions

diff --git a/src/transport/transport-testing.h b/src/transport/transport-testing.h
index cfcffaff6..25a772001 100644
--- a/src/transport/transport-testing.h
+++ b/src/transport/transport-testing.h
@@ -27,31 +27,51 @@
 
 #include "platform.h"
 #include "gnunet_common.h"
-#include "gnunet_hello_lib.h"
 #include "gnunet_getopt_lib.h"
 #include "gnunet_os_lib.h"
 #include "gnunet_program_lib.h"
 #include "gnunet_transport_service.h"
-#include "transport.h"
 
 
+/**
+ * Context for a single peer
+ */
 struct PeerContext
 {
   struct GNUNET_CONFIGURATION_Handle *cfg;
+
   struct GNUNET_TRANSPORT_Handle *th;
+
   struct GNUNET_PeerIdentity id;
+
   struct GNUNET_OS_Process *arm_proc;
 
   GNUNET_TRANSPORT_ReceiveCallback rec;
+
   GNUNET_TRANSPORT_NotifyConnect nc;
+
   GNUNET_TRANSPORT_NotifyDisconnect nd;
+
   void * cb_cls;
 
   char * servicehome;
 };
 
+/**
+ * Callback when two peers are connected and both have called the connect callback
+ * to notify clients about a new peer
+ */
 typedef void (*GNUNET_TRANSPORT_TESTING_connect_cb) (struct PeerContext * p1, struct PeerContext * p2, void *cls);
 
+
+/**
+ * Start a peer with the given configuration
+ * @param rec receive callback
+ * @param nc connect callback
+ * @param nd disconnect callback
+ * @param cb_cls closure for callback
+ * @return the peer context
+ */
 struct PeerContext *
 GNUNET_TRANSPORT_TESTING_start_peer (const char * cfgname,
     GNUNET_TRANSPORT_ReceiveCallback rec,
@@ -59,9 +79,25 @@ GNUNET_TRANSPORT_TESTING_start_peer (const char * cfgname,
     GNUNET_TRANSPORT_NotifyDisconnect nd,
     void * cb_cls);
 
+
+/**
+ * shutdown the given peer
+ * @param p the peer
+ */
+
 void
 GNUNET_TRANSPORT_TESTING_stop_peer (struct PeerContext * pc);
 
+
+/**
+ * Connect the given peers and call the callback when both peers report the
+ * inbound connection. Remarks: start_peer's notify_connect callback can be called
+ * before.
+ * @param p1 peer 1
+ * @param p2 peer 2
+ * @param cb the callback to call
+ * @param cb_cls callback cls
+ */
 void
 GNUNET_TRANSPORT_TESTING_connect_peers (struct PeerContext * p1,
     struct PeerContext * p2,