/*
This file is part of GNUnet.
- (C) 2011, 2012 Christian Grothoff
+ Copyright (C) 2011, 2012 Christian Grothoff
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_helper_lib.h
- * @brief API for dealing with (SUID) helper processes that communicate via
- * GNUNET_MessageHeaders on stdin/stdout
* @author Philipp Toelke
* @author Christian Grothoff
+ *
+ * @file
+ * API for dealing with SUID helper processes
+ *
+ * @defgroup helper Helper library
+ * Dealing with SUID helper processes.
+ *
+ * Provides an API for dealing with (SUID) helper processes
+ * that communicate via GNUNET_MessageHeaders on STDIN/STDOUT.
+ *
+ * @{
*/
#ifndef GNUNET_HELPER_LIB_H
/**
* Continuation function.
- *
+ *
* @param cls closure
* @param result #GNUNET_OK on success,
* #GNUNET_NO if helper process died
* @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,
+ * @return NULL if the message was dropped,
* otherwise handle to cancel @a cont (actual transmission may
* not be abortable)
*/
struct GNUNET_HELPER_SendHandle *
-GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
+GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
const struct GNUNET_MessageHeader *msg,
int can_drop,
GNUNET_HELPER_Continuation cont,
void
GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh);
-#endif
+
+#endif
/* end of include guard: GNUNET_HELPER_LIB_H */
+
+/** @} */ /* end of group */