diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-10-02 20:49:01 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-10-02 20:49:01 +0000 |
commit | 0452911c66bfbd8852eea27d90108be97aa84982 (patch) | |
tree | 9f59ff4a397754b5598a08917381b28cf6fe291f /src/util | |
parent | 6a34f8a03004e15e28e7ac11261ab9585e223b75 (diff) |
-docu helper api better
Diffstat (limited to 'src/util')
-rw-r--r-- | src/util/helper.c | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/util/helper.c b/src/util/helper.c index c9523f2033..0da702876e 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. * |