Improve doxygen documentation.

2014-08-26 21:38:09 +02:00
parent 6c7cb5c0ab
commit 22f6c1e043
17 changed files with 143 additions and 108 deletions
@@ -1,7 +1,8 @@
 #ifndef UC_RATE_LIMIT_H_
 #define UC_RATE_LIMIT_H_

-/** This is a rate limiter, based on the token bucket principle.
+/** @file
+ * This is a rate limiter, based on the token bucket principle.
 * We have X amount of tickets(=our rate) per Y amount of time,
 *  
 * The allowed tickets increases with X per Y amount of time.