/*
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
*/
/**
- * @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
* 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.
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__;
/**
- * 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.
*
/* ifndef GNUNET_BANDWIDTH_LIB_H */
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_bandwidth_lib.h */