aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorDavid Waern <david.waern@gmail.com>2009-12-21 14:12:41 +0000
committerDavid Waern <david.waern@gmail.com>2009-12-21 14:12:41 +0000
commitfe5699dacd6755cceed09ae53a78f13d9e8f6b2f (patch)
tree3e418dc6589ad615cefd88841f28b17251072014 /src
parentbcf38417f94acb93d4cf34ecb25c63052c1a94da (diff)
Improve doc of DocName
Diffstat (limited to 'src')
-rw-r--r--src/Haddock/Types.hs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/Haddock/Types.hs b/src/Haddock/Types.hs
index b4853379..f3b35540 100644
--- a/src/Haddock/Types.hs
+++ b/src/Haddock/Types.hs
@@ -52,8 +52,9 @@ noDocForDecl = (Nothing, Map.empty)
type DeclInfo = (Decl, DocForDecl Name, [(Name, DocForDecl Name)])
--- | A 'DocName' is an identifier that may be documented. The 'Module'
--- component specifies the place which we want to link to in the documentation.
+-- | A 'DocName' identifies something that may have documentation. The 'Module'
+-- argument specifies where we prefer to link to in the documentation. It may
+-- be different than the original module.
data DocName = Documented Name Module | Undocumented Name
deriving Eq