From 74d1173fa022cc8f520ff33c2620507522423e42 Mon Sep 17 00:00:00 2001
From: alexbiehl <alex.biehl@gmail.com>
Date: Mon, 31 Jul 2017 21:50:24 +0200
Subject: [PATCH] Prepare haddock-library-1.4.5 release
---
haddock-library/haddock-library.cabal | 3 ++-
haddock-library/src/Documentation/Haddock/Markup.hs | 6 +++++-
haddock-library/src/Documentation/Haddock/Types.hs | 8 ++++++++
3 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/haddock-library/haddock-library.cabal b/haddock-library/haddock-library.cabal
index 44834aa9..0a07094b 100644
--- a/haddock-library/haddock-library.cabal
+++ b/haddock-library/haddock-library.cabal
@@ -15,7 +15,8 @@ bug-reports: https://github.com/haskell/haddock/issues
category: Documentation
build-type: Simple
cabal-version: >= 2.0
-
+extra-source-files:
+ CHANGES.md
library
default-language: Haskell2010
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
--
GitLab