/*
This file is part of GNUnet
- (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
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
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_dns_service.h
- * @brief API to access the DNS service.
* @author Christian Grothoff
+ *
+ * @file
+ * API to access the DNS service.
+ *
+ * @defgroup dns DNS service
+ *
+ * @see [Documentation](https://gnunet.org/gnunet-service-dns)
+ *
+ * @{
*/
-#ifndef GNUNET_DNS_SERVICE_NEW_H
-#define GNUNET_DNS_SERVICE_NEW_H
+#ifndef GNUNET_DNS_SERVICE_H
+#define GNUNET_DNS_SERVICE_H
-#include "gnunet_common.h"
#include "gnunet_util_lib.h"
/**
* Flags that specify when to call the client's handler.
- */
+ */
enum GNUNET_DNS_Flags
{
* must always be a valid DNS reply and not a mutated DNS request.
*
* @param rh request that should now be answered
- * @param reply_length size of reply (uint16_t to force sane size)
+ * @param reply_length size of @a reply (uint16_t to force sane size)
* @param reply reply data
*/
void
-GNUNET_DNS_request_answer (struct GNUNET_DNS_RequestHandle *rh,
+GNUNET_DNS_request_answer (struct GNUNET_DNS_RequestHandle *rh,
uint16_t reply_length,
const char *reply);
* Connect to the service-dns
*
* @param cfg configuration to use
- * @param flags when to call rh
+ * @param flags when to call @a rh
* @param rh function to call with DNS requests
- * @param rh_cls closure to pass to rh
- * @return DNS handle
+ * @param rh_cls closure to pass to @a rh
+ * @return DNS handle
*/
struct GNUNET_DNS_Handle *
GNUNET_DNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
void
GNUNET_DNS_disconnect (struct GNUNET_DNS_Handle *dh);
+
#endif
+
+/** @} */ /* end of group */