filter.c: Add documentation of stat_item_values[].
authorAndre Noll <maan@tuebingen.mpg.de>
Fri, 2 Jan 2015 01:38:06 +0000 (01:38 +0000)
committerAndre Noll <maan@tuebingen.mpg.de>
Mon, 12 Jan 2015 22:29:07 +0000 (23:29 +0100)
filter.c

index 79574db..768a99f 100644 (file)
--- a/filter.c
+++ b/filter.c
 /** 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. */