From 0579acae1bf72cd78a707c0f2fe2556e645ccc7e Mon Sep 17 00:00:00 2001
From: stuebinm
Date: Sun, 14 Nov 2021 03:19:00 +0100
Subject: config: some small documentation

---
 lib/LintConfig.hs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'lib')

diff --git a/lib/LintConfig.hs b/lib/LintConfig.hs
index 1b1b1bc..28559bd 100644
--- a/lib/LintConfig.hs
+++ b/lib/LintConfig.hs
@@ -31,9 +31,13 @@ type family HKD f a where
 
 data LintConfig f = LintConfig
   { configScriptInject   :: HKD f (Maybe Text)
+  -- ^ Link to Script that should be injected
   , configAssemblyTag    :: HKD f Text
+  -- ^ Assembly name (used for jitsiRoomAdminTag)
   , configMaxWarnLevel   :: HKD f Level
+  -- ^ Maximum warn level allowed before the lint fails
   , configDontCopyAssets :: HKD f Bool
+  -- ^ Don't copy map assets (mostly useful for development)
   } deriving (Generic)
 
 type LintConfig' = LintConfig Identity
-- 
cgit v1.2.3