summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorstuebinm2021-11-14 03:19:00 +0100
committerstuebinm2021-11-14 03:19:00 +0100
commit0579acae1bf72cd78a707c0f2fe2556e645ccc7e (patch)
tree56e4a62a08ef2808a4945c5f7e2787f6532bed5e /lib
parent0e5951eedebd2f0d3991454f7bcaf5f7f749cb06 (diff)
config: some small documentation
Diffstat (limited to 'lib')
-rw-r--r--lib/LintConfig.hs4
1 files changed, 4 insertions, 0 deletions
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