From: Andre Noll <maan@tuebingen.mpg.de>
Date: Fri, 2 Jan 2015 01:38:06 +0000 (+0000)
Subject: filter.c: Add documentation of stat_item_values[].
X-Git-Tag: v0.5.4~16
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=95255fc8827336e4f2456262b706bb448bdec59f;p=paraslash.git

filter.c: Add documentation of stat_item_values[].
---

diff --git a/filter.c b/filter.c
index 79574db1..768a99fb 100644
--- a/filter.c
+++ b/filter.c
@@ -24,6 +24,12 @@
 /** The list of all status items used by para_{server,audiod,gui}. */
 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
 
+/**
+ * Dummy version which only contains NULL pointers.
+ *
+ * This is used by the amp filter which first tries to obtain the amplification
+ * value from an element in this array.
+ */
 char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
 
 /** Initialize the array of errors for para_filter. */