fix bad free
[oweals/gnunet.git] / src / include / gnunet_ats_service.h
index b727b4f9aaf29d87dba24097887ba444604a707c..a9fd519d4fab0d525abef4bbf3d4b3d98c75eddb 100644 (file)
@@ -1,27 +1,33 @@
 /*
  This file is part of GNUnet.
- Copyright (C) 2010-2015 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010-2015 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 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ 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.
Affero 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., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 /**
- * @file include/gnunet_ats_service.h
- * @brief automatic transport selection and outbound bandwidth determination
+ * @file
+ * Automatic transport selection and outbound bandwidth determination
+ *
  * @author Christian Grothoff
  * @author Matthias Wachs
+ *
+ * @defgroup ats  ATS service
+ * Automatic Transport Selection and outbound bandwidth determination
+ *
+ * @see [Documentation](https://gnunet.org/ats-subsystem)
+ *
+ * @{
  */
 #ifndef GNUNET_ATS_SERVICE_H
 #define GNUNET_ATS_SERVICE_H
@@ -63,7 +69,7 @@ enum GNUNET_ATS_Network_Type
   /**
    * Bluetooth LAN
    */
-  GNUNET_ATS_NET_BT = 5
+  GNUNET_ATS_NET_BT = 5,
 
 /**
  * Number of network types supported by ATS
@@ -518,7 +524,7 @@ GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 /**
  * Get information about addresses known to the ATS subsystem.
  *
- * @param handle the performance handle to use
+ * @param ph the performance handle to use
  * @param peer peer idm can be NULL for all peers
  * @param all #GNUNET_YES to get information about all addresses or #GNUNET_NO to
  *        get only address currently used
@@ -528,7 +534,7 @@ GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
  * @return handle to abort the operation
  */
 struct GNUNET_ATS_AddressListHandle *
-GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
+GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *ph,
                                        const struct GNUNET_PeerIdentity *peer,
                                        int all,
                                        GNUNET_ATS_AddressInformationCallback infocb,
@@ -538,10 +544,10 @@ GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *hand
 /**
  * Cancel a pending address listing operation
  *
- * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
+ * @param alh the `struct GNUNET_ATS_AddressListHandle` handle to cancel
  */
 void
-GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
+GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *alh);
 
 
 /**
@@ -696,4 +702,7 @@ GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
                                      ...);
 
 #endif
+
+/** @} */  /* end of group */
+
 /* end of file gnunet-service-transport_ats.h */