From 493653126b49d9cbd6e0e7501c68adb46ea9847c Mon Sep 17 00:00:00 2001
From: Adrian Cochrane <adrian@openwork.nz>
Date: Wed, 12 Apr 2023 15:54:36 +1200
Subject: [PATCH] Describe remaining submodules.

---
 Graphics/Layout/Arithmetic.hs | 2 ++
 Graphics/Layout/Box.hs        | 2 ++
 Graphics/Layout/CSS.hs        | 1 +
 Graphics/Layout/Flow.hs       | 2 ++
 Graphics/Layout/Grid.hs       | 1 +
 Graphics/Layout/Inline.hs     | 2 ++
 6 files changed, 10 insertions(+)

diff --git a/Graphics/Layout/Arithmetic.hs b/Graphics/Layout/Arithmetic.hs
index 3ee01da..5e1675f 100644
--- a/Graphics/Layout/Arithmetic.hs
+++ b/Graphics/Layout/Arithmetic.hs
@@ -1,4 +1,6 @@
 {-# LANGUAGE OverloadedStrings #-}
+-- | (Unused) Parses & evaluates calc() expressions.
+-- Implemented using The Shunting Yard Algorithm.
 module Graphics.Layout.Arithmetic(Opcode(..), parseCalc, verifyCalc,
         evalCalc, mapCalc) where
 
diff --git a/Graphics/Layout/Box.hs b/Graphics/Layout/Box.hs
index a2122fa..bdd0dbe 100644
--- a/Graphics/Layout/Box.hs
+++ b/Graphics/Layout/Box.hs
@@ -1,4 +1,6 @@
 {-# LANGUAGE RecordWildCards #-}
+-- | Datastructures representing the CSS box model,
+-- & utilities for operating on them.
 module Graphics.Layout.Box(Border(..), mapX, mapY,
         Size(..), mapSizeX, mapSizeY,
         PaddedBox(..), zeroBox, lengthBox, mapX', mapY',
diff --git a/Graphics/Layout/CSS.hs b/Graphics/Layout/CSS.hs
index a443061..f1ee6ba 100644
--- a/Graphics/Layout/CSS.hs
+++ b/Graphics/Layout/CSS.hs
@@ -1,4 +1,5 @@
 {-# LANGUAGE OverloadedStrings #-}
+-- | Parses & desugars CSS properties to general CatTrap datastructures.
 module Graphics.Layout.CSS(CSSBox(..), BoxSizing(..), Display(..),
         finalizeCSS, finalizeCSS') where
 
diff --git a/Graphics/Layout/Flow.hs b/Graphics/Layout/Flow.hs
index 6661969..3dd004a 100644
--- a/Graphics/Layout/Flow.hs
+++ b/Graphics/Layout/Flow.hs
@@ -1,3 +1,5 @@
+-- | Sizes a block element & positions their children.
+-- Taking into account size bounds.
 module Graphics.Layout.Flow(flowMinWidth, flowNatWidth, flowMaxWidth, flowWidth,
         flowNatHeight, flowMinHeight, flowMaxHeight, flowHeight,
         positionFlow, layoutFlow) where
diff --git a/Graphics/Layout/Grid.hs b/Graphics/Layout/Grid.hs
index 801c841..04efdcf 100644
--- a/Graphics/Layout/Grid.hs
+++ b/Graphics/Layout/Grid.hs
@@ -1,4 +1,5 @@
 {-# LANGUAGE RecordWildCards, OverloadedStrings #-}
+-- | Sizes grid cells & positions elements to them.
 module Graphics.Layout.Grid(Grid(..), Track(..), GridItem(..), GridItem'(..), Alignment(..),
         buildTrack, buildGrid, setCellBox, enumerate, gridItemBox, cellSize,
         trackMin, trackNat, gridEstWidth, sizeTrackMins, sizeTrackNats, sizeTrackMaxs,
diff --git a/Graphics/Layout/Inline.hs b/Graphics/Layout/Inline.hs
index 11bede7..95aecea 100644
--- a/Graphics/Layout/Inline.hs
+++ b/Graphics/Layout/Inline.hs
@@ -1,4 +1,6 @@
 {-# LANGUAGE TupleSections #-}
+-- | Sizes inline text & extracts positioned children,
+-- wraps Balkón for the actual logic.
 module Graphics.Layout.Inline(inlineMinWidth, inlineMin, inlineNatWidth, inlineHeight,
     inlineSize, inlineChildren, layoutSize, layoutChildren,
     fragmentSize, fragmentSize', fragmentPos) where
-- 
2.30.2