From fe5699dacd6755cceed09ae53a78f13d9e8f6b2f Mon Sep 17 00:00:00 2001 From: David Waern Date: Mon, 21 Dec 2009 14:12:41 +0000 Subject: Improve doc of DocName --- src/Haddock/Types.hs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'src/Haddock') 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 -- cgit v1.2.3