aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/Haddock/Types.hs2
1 files changed, 2 insertions, 0 deletions
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