-skeletons for transport-ng

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

diff --git a/src/include/gnunet_load_lib.h b/src/include/gnunet_load_lib.h
index 40323e70905b0caba97c2f86e4dc667d9450714a..e36821b3ed990301f1a5e2ba16101375a79df87a 100644 (file)
--- a/src/include/gnunet_load_lib.h
+++ b/src/include/gnunet_load_lib.h
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet.
-     (C) 2010 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010 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
@@ -14,14 +14,19 @@
 
      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_load_lib.h
- * @brief functions related to load calculations
  * @author Christian Grothoff
+ *
+ * @file
+ * Functions related to load calculations
+ *
+ * @defgroup load  Load library
+ * Load calculations.
+ * @{
  */
 
 #ifndef GNUNET_LOAD_LIB_H
@@ -51,8 +56,8 @@ struct GNUNET_LOAD_Value;
  *        frequency, 0-load values will be added to the load
  * @return the new load value
  */
-struct GNUNET_LOAD_Value *GNUNET_LOAD_value_init (struct GNUNET_TIME_Relative
-                                                  autodecline);
+struct GNUNET_LOAD_Value *
+GNUNET_LOAD_value_init (struct GNUNET_TIME_Relative autodecline);
 
 
 /**
@@ -83,7 +88,8 @@ GNUNET_LOAD_value_set_decline (struct GNUNET_LOAD_Value *load,
  *         100 if the latest updates were so large
  *         that we could not do proper calculations
  */
-double GNUNET_LOAD_get_load (struct GNUNET_LOAD_Value *load);
+double
+GNUNET_LOAD_get_load (struct GNUNET_LOAD_Value *load);
 
 
 /**
@@ -92,7 +98,8 @@ double GNUNET_LOAD_get_load (struct GNUNET_LOAD_Value *load);
  * @param load load handle
  * @return zero if update was never called
  */
-double GNUNET_LOAD_get_average (struct GNUNET_LOAD_Value *load);
+double
+GNUNET_LOAD_get_average (struct GNUNET_LOAD_Value *load);
 
 
 /**
@@ -101,7 +108,8 @@ double GNUNET_LOAD_get_average (struct GNUNET_LOAD_Value *load);
  * @param load to update
  * @param data latest measurement value (for example, delay)
  */
-void GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data);
+void
+GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */
@@ -113,4 +121,7 @@ void GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data);
 
 /* ifndef GNUNET_LOAD_LIB_H */
 #endif
+
+/** @} */  /* end of group */
+
 /* end of gnunet_load_lib.h */