-fix no-dot-in-path issue on FreeBSD bot

[oweals/gnunet.git] / src / gns / nss / nss_gns_query.h

diff --git a/src/gns/nss/nss_gns_query.h b/src/gns/nss/nss_gns_query.h
index ab8b6cb43cc9467bad5b205f515fc4ea5ba315cf..65b0311fe3fb4fa74494612d8708ee8d269428db 100644 (file)
--- a/src/gns/nss/nss_gns_query.h
+++ b/src/gns/nss/nss_gns_query.h
@@ -1,27 +1,28 @@
-#ifndef fooqueryhfoo
-#define fooqueryhfoo
-
-/* $Id$ */
-
-/***
-  This file is part of nss-mdns.
- 
-  nss-mdns is free software; you can redistribute it and/or modify it
-  under the terms of the GNU Lesser General Public License as
-  published by the Free Software Foundation; either version 2 of the
-  License, or (at your option) any later version.
- 
-  nss-mdns is distributed in the hope that it will be useful, but
-  WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  General Public License for more details.
- 
-  You should have received a copy of the GNU Lesser General Public
-  License along with nss-mdns; if not, write to the Free Software
-  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-  USA.
-***/
-
+/*
+     This file is part of GNUnet.
+     (C) 2012 Christian Grothoff (and other contributing authors)
+
+     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 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     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.
+*/
+#ifndef NSS_GNS_QUERY_H
+#define NSS_GNS_QUERY_H
+
+/**
+ * Parts taken from nss-mdns
+ */
 #include <inttypes.h>
 
 /* Maximum number of entries to return */
@@ -46,6 +47,15 @@ struct userdata {
   } data;
 };
 
+/**
+ * Wrapper function that uses gnunet-gns cli tool to resolve
+ * an IPv4/6 address.
+ *
+ * @param af address family
+ * @param name the name to resolve
+ * @param u the userdata (result struct)
+ * @return -1 on error else 0
+ */
 int gns_resolve_name(int af,
                const char *name,
                struct userdata *userdata);