config: add documentation for config_t

1 files changed, 6 insertions, 0 deletions

diff --git a/include/config.h b/include/config.h
index 924f606..a5edcc9 100644
--- a/include/config.h
+++ b/include/config.h
@@ -24,6 +24,12 @@
 #define DELIM "="
 #define DELIM_ARRAY ","
 
+/*
+ * Each config has a list of "top-level keys", with corresponding values.
+ * Simple string values are stored in the values array, with array-values being
+ * stored in array_values. When a key has an array value, its corresponding
+ * entry in values is NULL, and vice versa with simple string values.
+ */
 typedef struct {
     list_t *keys;
     list_t *values;