[GNUnet-SVN] r29804 - in gnunet/src: include util

[gnunet]

Author: grothoff
Date: 2013-10-02 22:49:01 +0200 (Wed, 02 Oct 2013)
New Revision: 29804

Modified:
   gnunet/src/include/gnunet_helper_lib.h
   gnunet/src/util/helper.c
Log:
-docu helper api better

Modified: gnunet/src/include/gnunet_helper_lib.h
===================================================================
--- gnunet/src/include/gnunet_helper_lib.h      2013-10-02 20:47:18 UTC (rev 
29803)
+++ gnunet/src/include/gnunet_helper_lib.h      2013-10-02 20:49:01 UTC (rev 
29804)
@@ -124,7 +124,7 @@
  * @param cls closure
  * @param result #GNUNET_OK on success,
  *               #GNUNET_NO if helper process died
- *               #GNUNET_SYSERR during GNUNET_HELPER_stop
+ *               #GNUNET_SYSERR during GNUNET_HELPER_destroy
  */
 typedef void (*GNUNET_HELPER_Continuation)(void *cls,
                                           int result);
@@ -142,10 +142,11 @@
  * @param h helper to send message to
  * @param msg message to send
  * @param can_drop can the message be dropped if there is already one in the 
queue?
- * @param cont continuation to run once the message is out
+ * @param cont continuation to run once the message is out (#GNUNET_OK on 
succees, #GNUNET_NO
+ *             if the helper process died, #GNUNET_SYSERR during 
#GNUNET_HELPER_destroy).
  * @param cont_cls closure for @a cont
  * @return NULL if the message was dropped, 
- *         otherwise handle to cancel *cont* (actual transmission may
+ *         otherwise handle to cancel @a cont (actual transmission may
  *         not be abortable)
  */
 struct GNUNET_HELPER_SendHandle *

Modified: gnunet/src/util/helper.c
===================================================================
--- gnunet/src/util/helper.c    2013-10-02 20:47:18 UTC (rev 29803)
+++ gnunet/src/util/helper.c    2013-10-02 20:49:01 UTC (rev 29804)
@@ -541,8 +541,8 @@
  * Kills the helper, closes the pipe and frees the handle
  *
  * @param h handle to helper to stop
- * @param soft_kill if GNUNET_YES, signals termination by closing the helper's
- *          stdin; GNUNET_NO to signal termination by sending SIGTERM to helper
+ * @param soft_kill if #GNUNET_YES, signals termination by closing the helper's
+ *          stdin; #GNUNET_NO to signal termination by sending SIGTERM to 
helper
  */
 void
 GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h, int soft_kill)
@@ -624,9 +624,9 @@
  * @param h helper to send message to
  * @param msg message to send
  * @param can_drop can the message be dropped if there is already one in the 
queue?
- * @param cont continuation to run once the message is out (PREREQ_DONE on 
succees, CANCEL
- *             if the helper process died, NULL during GNUNET_HELPER_stop).
- * @param cont_cls closure for 'cont'
+ * @param cont continuation to run once the message is out (#GNUNET_OK on 
succees, #GNUNET_NO
+ *             if the helper process died, #GNUNET_SYSERR during 
#GNUNET_HELPER_destroy).
+ * @param cont_cls closure for @a cont
  * @return NULL if the message was dropped, 
  *         otherwise handle to cancel *cont* (actual transmission may
  *         not be abortable)
@@ -666,7 +666,7 @@
 }
 
 /**
- * Cancel a 'send' operation.  If possible, transmitting the
+ * Cancel a #GNUNET_HELPER_send operation.  If possible, transmitting the
  * message is also aborted, but at least 'cont' won't be
  * called.
  *