aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorDavid Waern <david.waern@gmail.com>2008-11-10 01:19:18 +0000
committerDavid Waern <david.waern@gmail.com>2008-11-10 01:19:18 +0000
commit876568ca9afbe5891a8caa3364208f915a25cd9e (patch)
tree8593bdb5a2417d403439f52e4b5a90208573a205 /src
parentc43da2cd1be804351100a599d0e6db5cc19cf747 (diff)
Document the functions in H.DocName
Diffstat (limited to 'src')
-rw-r--r--src/Haddock/DocName.hs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/Haddock/DocName.hs b/src/Haddock/DocName.hs
index 959d028b..5bb3c4bb 100644
--- a/src/Haddock/DocName.hs
+++ b/src/Haddock/DocName.hs
@@ -19,10 +19,12 @@ data DocName = Documented Name Module | Undocumented Name
deriving Eq
+-- | The 'OccName' belonging to this name
docNameOcc :: DocName -> OccName
docNameOcc = nameOccName . docNameOrig
+-- | The original definition site of this name
docNameOrig :: DocName -> Name
docNameOrig (Documented name _) = name
docNameOrig (Undocumented name) = name