From 59e3c7f277a64f09ef65c4ca42d7c2398f04acd4 Mon Sep 17 00:00:00 2001
From: Jasper Van der Jeugt <jaspervdj@gmail.com>
Date: Sun, 24 Jan 2010 10:30:19 +0100
Subject: Wrote some more documentation.

---
 src/Text/Hakyll/CompressCSS.hs | 2 ++
 src/Text/Hakyll/Page.hs        | 2 +-
 src/Text/Hakyll/Render.hs      | 2 ++
 src/Text/Hakyll/Util.hs        | 5 ++++-
 4 files changed, 9 insertions(+), 2 deletions(-)

(limited to 'src/Text/Hakyll')

diff --git a/src/Text/Hakyll/CompressCSS.hs b/src/Text/Hakyll/CompressCSS.hs
index d575348..0836f69 100644
--- a/src/Text/Hakyll/CompressCSS.hs
+++ b/src/Text/Hakyll/CompressCSS.hs
@@ -1,3 +1,5 @@
+-- | Module used for CSS compression. The compression is currently in a simple
+--   state, but would typically reduce the number of bytes by about 25%.
 module Text.Hakyll.CompressCSS
     ( compressCSS
     ) where
diff --git a/src/Text/Hakyll/Page.hs b/src/Text/Hakyll/Page.hs
index 3b76bfd..abfd0b8 100644
--- a/src/Text/Hakyll/Page.hs
+++ b/src/Text/Hakyll/Page.hs
@@ -1,10 +1,10 @@
+-- | A module for dealing with "Page"s. This module is mostly internally used.
 module Text.Hakyll.Page 
     ( Page
     , fromContext
     , getValue
     , getBody
     , readPage
-    , splitAtDelimiters
     ) where
 
 import qualified Data.Map as M
diff --git a/src/Text/Hakyll/Render.hs b/src/Text/Hakyll/Render.hs
index 030d999..e1041a0 100644
--- a/src/Text/Hakyll/Render.hs
+++ b/src/Text/Hakyll/Render.hs
@@ -1,3 +1,5 @@
+-- | Module containing rendering functions. All these functions are used to
+--   render files to the @_site@ directory.
 module Text.Hakyll.Render 
     ( depends
     , render
diff --git a/src/Text/Hakyll/Util.hs b/src/Text/Hakyll/Util.hs
index 5105a31..358c60e 100644
--- a/src/Text/Hakyll/Util.hs
+++ b/src/Text/Hakyll/Util.hs
@@ -1,3 +1,4 @@
+-- | Miscellaneous text manipulation functions.
 module Text.Hakyll.Util 
     ( trim
     , stripHTML
@@ -26,6 +27,8 @@ stripHTML str = let (beforeTag, rest) = break (== '<') str
 -- | Make a HTML link.
 --
 --   > link "foo" "bar.html" == "<a href='bar.html'>foo</a>"
-link :: String -> String -> String
+link :: String -- ^ Link text.
+     -> String -- ^ Link destination.
+     -> String
 link text destination = "<a href=\"" ++ destination ++ "\">"
                       ++ text ++ "</a>"
-- 
cgit v1.2.3