gnunetutil: add 2d and 3d allocation including tests

[oweals/gnunet.git] / src / include / gnunet_nat_lib.h

diff --git a/src/include/gnunet_nat_lib.h b/src/include/gnunet_nat_lib.h
index c951a0f3a0ee694c17fb3908fce995f12be8070c..853a86c2dc050f871cc71291b9eea2a3776263cb 100644 (file)
--- a/src/include/gnunet_nat_lib.h
+++ b/src/include/gnunet_nat_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2007-2014 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2007-2014 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
@@ -19,11 +19,18 @@
 */
 
 /**
- * @file include/gnunet_nat_lib.h
- * @brief Library handling UPnP and NAT-PMP port forwarding and
- *     external IP address retrieval
  * @author Christian Grothoff
  * @author Milan Bouchet-Valat
+ *
+ * @file
+ * Library handling UPnP and NAT-PMP port forwarding
+ * and external IP address retrieval
+ *
+ * @defgroup nat  NAT library
+ * Library handling UPnP and NAT-PMP port forwarding
+ * and external IP address retrieval
+ *
+ * @{
  */
 
 #ifndef GNUNET_NAT_LIB_H
@@ -349,10 +356,10 @@ GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst);
  * @param addr the address, NULL on errors
  * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
  */
-typedef void (*GNUNET_NAT_IPCallback) (void *cls,
-                                       const struct in_addr *addr,
-                                       enum GNUNET_NAT_StatusCode result);
-
+typedef void
+(*GNUNET_NAT_IPCallback) (void *cls,
+                          const struct in_addr *addr,
+                          enum GNUNET_NAT_StatusCode result);
 
 
 /**
@@ -492,8 +499,6 @@ GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah);
 struct GNUNET_NAT_STUN_Handle;
 
 
-
-
 /**
  * Function called with the result if an error happened during STUN request.
  *
@@ -569,9 +574,8 @@ GNUNET_NAT_stun_handle_packet (const void *data,
  * You don't need to call anything else to check if the packet is valid,
  *
  * @param cls the NAT handle
- * @param data, packet
- * @param len, packet length
- *
+ * @param data packet
+ * @param len length of @a data
  * @return #GNUNET_NO if it can't decode, #GNUNET_YES if is a packet
  */
 int
@@ -580,7 +584,8 @@ GNUNET_NAT_is_valid_stun_packet (void *cls,
                                  size_t len);
 
 
-
 #endif
 
+/** @} */  /* end of group */
+
 /* end of gnunet_nat_lib.h */