From 0452911c66bfbd8852eea27d90108be97aa84982 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Wed, 2 Oct 2013 20:49:01 +0000 Subject: -docu helper api better --- src/include/gnunet_helper_lib.h | 7 ++++--- src/util/helper.c | 12 ++++++------ 2 files changed, 10 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/include/gnunet_helper_lib.h b/src/include/gnunet_helper_lib.h index 281ee9ba6..fde0a69ed 100644 --- a/src/include/gnunet_helper_lib.h +++ b/src/include/gnunet_helper_lib.h @@ -124,7 +124,7 @@ GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h, int soft_kill); * @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 @@ struct GNUNET_HELPER_SendHandle; * @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 * diff --git a/src/util/helper.c b/src/util/helper.c index c9523f203..0da702876 100644 --- a/src/util/helper.c +++ b/src/util/helper.c @@ -541,8 +541,8 @@ GNUNET_HELPER_destroy (struct GNUNET_HELPER_Handle *h) * 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 @@ helper_write (void *cls, * @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 @@ GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h, } /** - * 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. * -- cgit v1.2.3