MQ doc

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

diff --git a/src/include/gnunet_bandwidth_lib.h b/src/include/gnunet_bandwidth_lib.h
index 1190210babfc7e877b23ea8c349a105a9b4a3689..178ddaaacaacb0026b61c00aae49b1d10dfc44ae 100644 (file)
--- a/src/include/gnunet_bandwidth_lib.h
+++ b/src/include/gnunet_bandwidth_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     Copyright (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
@@ -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_bandwidth_lib.h
- * @brief functions related to bandwidth (unit)
  * @author Christian Grothoff
+ *
+ * @file
+ * Functions related to bandwidth (unit)
+ *
+ * @defgroup bandwidth  Bandwidth library
+ * Functions related to bandwidth (unit)
+ * @{
  */
 
 #ifndef GNUNET_BANDWIDTH_LIB_H
@@ -113,7 +118,7 @@ struct GNUNET_BANDWIDTH_Tracker
    * Task scheduled to call the @e excess_cb once we have
    * reached the maximum bandwidth the tracker can hold.
    */
-  struct GNUNET_SCHEDULER_Task * excess_task;
+  struct GNUNET_SCHEDULER_Task *excess_task;
 
   /**
    * Time when we last updated the tracker.
@@ -121,7 +126,7 @@ struct GNUNET_BANDWIDTH_Tracker
   struct GNUNET_TIME_Absolute last_update__;
 
   /**
-   * Bandwidth limit to enforce in bytes per s.
+   * Bandwidth limit to enforce in bytes per second.
    */
   uint32_t available_bytes_per_s__;
 
@@ -284,7 +289,7 @@ GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
 
 
 /**
- * Compute how long we should wait until consuming 'size'
+ * Compute how long we should wait until consuming @a size
  * bytes of bandwidth in order to stay within the given
  * quota.
  *
@@ -329,4 +334,7 @@ GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av,
 
 /* ifndef GNUNET_BANDWIDTH_LIB_H */
 #endif
+
+/** @} */  /* end of group */
+
 /* end of gnunet_bandwidth_lib.h */