diff options
author | David Waern <david.waern@gmail.com> | 2009-03-27 22:06:26 +0000 |
---|---|---|
committer | David Waern <david.waern@gmail.com> | 2009-03-27 22:06:26 +0000 |
commit | 6a8c68f7004c80e43dbb2e8f8b21740b83228fc3 (patch) | |
tree | 8dfc55e1fdfbfef9583a1cf4e276960f8d5b1b75 | |
parent | 86bb3fc4d33202369cf87a96db9b99674aaa4535 (diff) |
Document DocName
-rw-r--r-- | src/Haddock/Types.hs | 2 |
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 |