From: Florian Dold <florian.dold@gmail.com>
Date: Mon, 29 Aug 2016 11:27:21 +0000 (+0000)
Subject: docs for service api
X-Git-Tag: initial-import-from-subversion-38251~323
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=6ad7f6037f6c56b0225118b6a641d66c16263f3a;p=oweals%2Fgnunet.git

docs for service api
---

diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h
index a3ad76f60..85b8f5f9c 100644
--- a/src/include/gnunet_service_lib.h
+++ b/src/include/gnunet_service_lib.h
@@ -355,29 +355,32 @@ GNUNET_SERVICE_ruN_ (int argc,
 
 
 /**
+ * Suspend accepting connections from the listen socket temporarily.
+ * Resume activity using #GNUNET_SERVICE_resume.
  *
- * @param sh
+ * @param sh service to stop accepting connections.
  */
 void
 GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh);
 
 /**
+ * Resume accepting connections from the listen socket.
  *
- * @param sh
+ * @param sh service to resume accepting connections.
  */
 void
 GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh);
 
 /**
+ * Continue receiving further messages from the given client.
+ * Must be called after each message received.
  *
- * @param c
+ * @param c the client to continue receiving from
  */
 void
 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c);
 
 /**
- *
- * @param c
  */
 void
 GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c);