aboutsummaryrefslogtreecommitdiff
path: root/haddock-library/src/Documentation
diff options
context:
space:
mode:
authoralexbiehl <alex.biehl@gmail.com>2017-07-31 21:50:24 +0200
committeralexbiehl <alex.biehl@gmail.com>2017-07-31 21:50:24 +0200
commit74d1173fa022cc8f520ff33c2620507522423e42 (patch)
tree4bd34e89d4a7d5514777f3202745a2aeb1a6656a /haddock-library/src/Documentation
parent619fd646518c08e7a9e34737eeb526d6e044f25a (diff)
Prepare haddock-library-1.4.5 release
Diffstat (limited to 'haddock-library/src/Documentation')
-rw-r--r--haddock-library/src/Documentation/Haddock/Markup.hs6
-rw-r--r--haddock-library/src/Documentation/Haddock/Types.hs8
2 files changed, 13 insertions, 1 deletions
diff --git a/haddock-library/src/Documentation/Haddock/Markup.hs b/haddock-library/src/Documentation/Haddock/Markup.hs
index b16cf049..1bf6c084 100644
--- a/haddock-library/src/Documentation/Haddock/Markup.hs
+++ b/haddock-library/src/Documentation/Haddock/Markup.hs
@@ -1,4 +1,8 @@
-module Documentation.Haddock.Markup where
+-- | @since 1.4.5
+module Documentation.Haddock.Markup (
+ markup
+ , idMarkup
+ ) where
import Documentation.Haddock.Types
diff --git a/haddock-library/src/Documentation/Haddock/Types.hs b/haddock-library/src/Documentation/Haddock/Types.hs
index 1e87edc0..0ab6bb4c 100644
--- a/haddock-library/src/Documentation/Haddock/Types.hs
+++ b/haddock-library/src/Documentation/Haddock/Types.hs
@@ -81,6 +81,14 @@ data DocH mod id
| DocHeader (Header (DocH mod id))
deriving (Eq, Show, Functor, Foldable, Traversable)
+-- | 'DocMarkupH' is a set of instructions for marking up documentation.
+-- In fact, it's really just a mapping from 'Doc' to some other
+-- type [a], where [a] is usually the type of the output (HTML, say).
+-- Use 'Documentation.Haddock.Markup.markup' to apply a 'DocMarkupH' to
+-- a 'DocH'.
+--
+-- @since 1.4.5
+--
data DocMarkupH mod id a = Markup
{ markupEmpty :: a
, markupString :: String -> a