From 1760d67f85c47b74a4b7b5d2d73c30f589dd704a Mon Sep 17 00:00:00 2001
From: Raghuram Subramani <raghus2247@gmail.com>
Date: Wed, 27 Aug 2025 11:25:55 -0400
Subject: config: add documentation for config_t

---
 include/config.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'include/config.h')

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;
-- 
cgit v1.2.3