From 32200a67afb65a5679fddb487e27bda3ff170f3c Mon Sep 17 00:00:00 2001
From: crumbtoo <crumb@disroot.org>
Date: Mon, 27 Nov 2023 17:50:34 -0700
Subject: [PATCH] haddock module headers

---
 src/Compiler/RLPC.hs | 7 +++++++
 src/Core/Examples.hs | 4 ++++
 src/Core/Lex.x       | 4 ++++
 src/Core/Parse.y     | 4 ++++
 src/Core/Syntax.hs   | 4 ++++
 src/Core/TH.hs       | 4 ++++
 6 files changed, 27 insertions(+)

diff --git a/src/Compiler/RLPC.hs b/src/Compiler/RLPC.hs
index bcb9618..8cc7373 100644
--- a/src/Compiler/RLPC.hs
+++ b/src/Compiler/RLPC.hs
@@ -1,3 +1,10 @@
+{-|
+Module      : Compiler.RLPC
+Description : Tools used to glue each piece of RLPC together
+
+This module implements the toolset common to the entire compiler, most notably
+errors and the family of RLPC monads.
+-}
 {-# LANGUAGE GeneralisedNewtypeDeriving, StandaloneDeriving #-}
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE DeriveGeneric, DerivingStrategies, DerivingVia #-}
diff --git a/src/Core/Examples.hs b/src/Core/Examples.hs
index a7a7c0a..e0a6563 100644
--- a/src/Core/Examples.hs
+++ b/src/Core/Examples.hs
@@ -1,3 +1,7 @@
+{-|
+Module      : Core.Examples
+Description : Core examples (may eventually be unit tests)
+-}
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE OverloadedStrings #-}
 module Core.Examples where
diff --git a/src/Core/Lex.x b/src/Core/Lex.x
index 6317c49..d86dded 100644
--- a/src/Core/Lex.x
+++ b/src/Core/Lex.x
@@ -1,4 +1,8 @@
 {
+{-|
+Module      : Core.Lex
+Description : Lexical analysis for the core language
+-}
 module Core.Lex
     ( lexCore
     , lexCore'
diff --git a/src/Core/Parse.y b/src/Core/Parse.y
index ecfb77b..26021ac 100644
--- a/src/Core/Parse.y
+++ b/src/Core/Parse.y
@@ -1,4 +1,8 @@
 {
+{-|
+Module : Core.Parse
+Description : Parser for the Core language
+-}
 module Core.Parse
     ( parseCore
     , parseCoreExpr
diff --git a/src/Core/Syntax.hs b/src/Core/Syntax.hs
index 18e3b7b..99e872d 100644
--- a/src/Core/Syntax.hs
+++ b/src/Core/Syntax.hs
@@ -1,3 +1,7 @@
+{-|
+Module      : Core.Syntax
+Description : Core ASTs and the like
+-}
 {-# LANGUAGE PatternSynonyms, OverloadedStrings #-}
 module Core.Syntax
     ( Expr(..)
diff --git a/src/Core/TH.hs b/src/Core/TH.hs
index ac283b1..5239239 100644
--- a/src/Core/TH.hs
+++ b/src/Core/TH.hs
@@ -1,3 +1,7 @@
+{-|
+Module      : Core.TH
+Description : Core quasiquoters
+-}
 module Core.TH
     ( coreExpr
     , coreProg