aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIsaac Dupree <id@isaac.cedarswampstudios.org>2009-08-23 18:28:16 +0000
committerIsaac Dupree <id@isaac.cedarswampstudios.org>2009-08-23 18:28:16 +0000
commit343da22f6ad9a54cf2f9243af55a00f31581c474 (patch)
tree7e6d90cb433a6cfe952c24738813985e7c31244a
parent2cf63ece0753146cd5a80cbd3655612b636fd0ec (diff)
add comment for FnArgsDoc type
-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 ac3f2b5f..544c7575 100644
--- a/src/Haddock/Types.hs
+++ b/src/Haddock/Types.hs
@@ -44,6 +44,8 @@ type HsDocString = HsDoc Name
type LHsDocString = Located HsDocString
#endif
+-- | Arguments and result are indexed by Int, zero-based from the left,
+-- because that's the easiest to use when recursing over types.
type FnArgsDoc name = Map Int (HsDoc name)
type DocForDecl name = (Maybe (HsDoc name), FnArgsDoc name)