[commit: haddock] ghc-head, ghc-head1, headdock-library-1.4.5, ie_avails, master, wip/T14529, wip/revert-ttg-2017-11-20, wip/ttg-2017-10-13, wip/ttg-2017-10-31, wip/ttg-2017-11-06, wip/ttg2-2017-11-10, wip/ttg3-2017-11-12, wip/ttg4-constraints-2017-11-13, wip/ttg6-unrevert-2017-11-22: Prepare haddock-library-1.4.5 release (74d1173)

git at git.haskell.org git at git.haskell.org
Tue Nov 28 11:53:40 UTC 2017


Repository : ssh://git@git.haskell.org/haddock

On branches: ghc-head,ghc-head1,headdock-library-1.4.5,ie_avails,master,wip/T14529,wip/revert-ttg-2017-11-20,wip/ttg-2017-10-13,wip/ttg-2017-10-31,wip/ttg-2017-11-06,wip/ttg2-2017-11-10,wip/ttg3-2017-11-12,wip/ttg4-constraints-2017-11-13,wip/ttg6-unrevert-2017-11-22
Link       : http://git.haskell.org/haddock.git/commitdiff/74d1173fa022cc8f520ff33c2620507522423e42

>---------------------------------------------------------------

commit 74d1173fa022cc8f520ff33c2620507522423e42
Author: alexbiehl <alex.biehl at gmail.com>
Date:   Mon Jul 31 21:50:24 2017 +0200

    Prepare haddock-library-1.4.5 release


>---------------------------------------------------------------

74d1173fa022cc8f520ff33c2620507522423e42
 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 44834aa..0a07094 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 b16cf04..1bf6c08 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 1e87edc..0ab6bb4 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



More information about the ghc-commits mailing list