aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Jakobi <simon.jakobi@gmail.com>2018-05-08 04:00:18 +0200
committerSimon Jakobi <simon.jakobi@gmail.com>2018-06-13 23:39:30 +0200
commit00c401b965e1468aee71caa4cffd049cadd515d8 (patch)
treec5f1645f02831a96646499e0e45476488cb50ecb
parent52405584f978c8d1afd6439b3ac0e3fd0f9b825e (diff)
Add docs for some DocH constructors (#814)
-rw-r--r--haddock-library/src/Documentation/Haddock/Types.hs3
1 files changed, 3 insertions, 0 deletions
diff --git a/haddock-library/src/Documentation/Haddock/Types.hs b/haddock-library/src/Documentation/Haddock/Types.hs
index 005ec186..b5dea3d4 100644
--- a/haddock-library/src/Documentation/Haddock/Types.hs
+++ b/haddock-library/src/Documentation/Haddock/Types.hs
@@ -107,8 +107,10 @@ data DocH mod id
| DocParagraph (DocH mod id)
| DocIdentifier id
| DocIdentifierUnchecked mod
+ -- ^ A qualified identifier that couldn't be resolved.
| DocModule String
| DocWarning (DocH mod id)
+ -- ^ This constructor has no counterpart in Haddock markup.
| DocEmphasis (DocH mod id)
| DocMonospaced (DocH mod id)
| DocBold (DocH mod id)
@@ -121,6 +123,7 @@ data DocH mod id
| DocMathInline String
| DocMathDisplay String
| DocAName String
+ -- ^ A (HTML) anchor.
| DocProperty String
| DocExamples [Example]
| DocHeader (Header (DocH mod id))