convert fs publish to MQ
[oweals/gnunet.git] / src / include / gnunet_dnsstub_lib.h
index 54740ec690bc4383084103fcc5c2fac10e5ec3f9..1c3305f7b18735f7709637400e1b687b90fec405 100644 (file)
@@ -1,6 +1,6 @@
 /*
       This file is part of GNUnet
-      Copyright (C) 2012 Christian Grothoff (and other contributing authors)
+      Copyright (C) 2012 GNUnet e.V.
 
       GNUnet is free software; you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published
  */
 
 /**
- * @file include/gnunet_dnsstub_lib.h
- * @brief API for helper library to send DNS requests to DNS resolver
  * @author Christian Grothoff
+ *
+ * @file
+ * API for helper library to send DNS requests to DNS resolver
+ *
+ * @defgroup dns-stub  DNS Stub library
+ * Helper library to send DNS requests to DNS resolver
+ * @{
  */
 #ifndef GNUNET_DNSSTUB_LIB_H
 #define GNUNET_DNSSTUB_LIB_H
@@ -65,12 +70,13 @@ GNUNET_DNSSTUB_stop (struct GNUNET_DNSSTUB_Context *ctx);
  * @param cls closure
  * @param rs socket that received the response
  * @param dns dns response, never NULL
- * @param dns_len number of bytes in 'dns'
+ * @param dns_len number of bytes in @a dns
  */
-typedef void (*GNUNET_DNSSTUB_ResultCallback)(void *cls,
-                                             struct GNUNET_DNSSTUB_RequestSocket *rs,
-                                             const struct GNUNET_TUN_DnsHeader *dns,
-                                             size_t dns_len);
+typedef void
+(*GNUNET_DNSSTUB_ResultCallback)(void *cls,
+                                 struct GNUNET_DNSSTUB_RequestSocket *rs,
+                                 const struct GNUNET_TUN_DnsHeader *dns,
+                                 size_t dns_len);
 
 
 /**
@@ -82,7 +88,7 @@ typedef void (*GNUNET_DNSSTUB_ResultCallback)(void *cls,
  * @param request DNS request to transmit
  * @param request_len number of bytes in msg
  * @param rc function to call with result
- * @param rc_cls closure for 'rc'
+ * @param rc_cls closure for @a rc
  * @return socket used for the request, NULL on error
  */
 struct GNUNET_DNSSTUB_RequestSocket *
@@ -102,7 +108,7 @@ GNUNET_DNSSTUB_resolve (struct GNUNET_DNSSTUB_Context *ctx,
  * @param request DNS request to transmit
  * @param request_len number of bytes in msg
  * @param rc function to call with result
- * @param rc_cls closure for 'rc'
+ * @param rc_cls closure for @a rc
  * @return socket used for the request, NULL on error
  */
 struct GNUNET_DNSSTUB_RequestSocket *
@@ -121,4 +127,7 @@ GNUNET_DNSSTUB_resolve2 (struct GNUNET_DNSSTUB_Context *ctx,
 void
 GNUNET_DNSSTUB_resolve_cancel (struct GNUNET_DNSSTUB_RequestSocket *rs);
 
+
 #endif
+
+/** @} */  /* end of group */