From 6a8c68f7004c80e43dbb2e8f8b21740b83228fc3 Mon Sep 17 00:00:00 2001 From: David Waern Date: Fri, 27 Mar 2009 22:06:26 +0000 Subject: Document DocName --- src/Haddock/Types.hs | 2 ++ 1 file changed, 2 insertions(+) (limited to 'src') diff --git a/src/Haddock/Types.hs b/src/Haddock/Types.hs index d20d3358..34e16ec1 100644 --- a/src/Haddock/Types.hs +++ b/src/Haddock/Types.hs @@ -26,6 +26,8 @@ type Doc = HsDoc Name type DeclInfo = (Decl, Maybe Doc, [(Name, Maybe Doc)]) +-- | A 'DocName' is an identifier that may be documented. The 'Module' +-- component specifies the place which we want to link to in the documentation. data DocName = Documented Name Module | Undocumented Name deriving Eq -- cgit v1.2.3