X-Git-Url: http://git.pk910.de/?a=blobdiff_plain;f=include%2Fuserload.h;h=3891ca8d67b2cb83a2a0f76b3beac64e3e36977e;hb=refs%2Fheads%2Fupstream;hp=2f95ade26ce2e7eeeeca9cbafffd4570c910f232;hpb=a8461738cd722ccdafa0f6ad127578c84cb57046;p=ircu2.10.12-pk.git

diff --git a/include/userload.h b/include/userload.h
index 2f95ade..3891ca8 100644
--- a/include/userload.h
+++ b/include/userload.h
@@ -19,8 +19,10 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
+ */
+/** @file
+ * @brief Userload tracking and statistics.
+ * @version $Id$
  */
 #ifndef INCLUDED_userload_h
 #define INCLUDED_userload_h
@@ -32,10 +34,11 @@ struct StatDesc;
  * Structures
  */
 
+/** Tracks load of various types of users. */
 struct current_load_st {
-  unsigned int client_count;
-  unsigned int local_count;
-  unsigned int conn_count;
+  unsigned int client_count; /**< Count of locally connected clients. */
+  unsigned int local_count; /**< This field is updated but apparently meaningless. */
+  unsigned int conn_count; /**< Locally connected clients plus servers. */
 };
 
 /*