aboutsummaryrefslogtreecommitdiff
path: root/src/HaddockTypes.hs
diff options
context:
space:
mode:
authorsimonmar <unknown>2002-04-24 15:14:12 +0000
committersimonmar <unknown>2002-04-24 15:14:12 +0000
commit995d3f9ed418352cb8e341630e7c7655080c1612 (patch)
tree48515c410f772e4c84bc3bd9448218ec7b5da500 /src/HaddockTypes.hs
parent106adbbe619e9bd42a6ca00f097d3eb22011f6f5 (diff)
[haddock @ 2002-04-24 15:14:11 by simonmar]
Grok the kind of module headers we use in fptools/libraries, and pass the "portability", "stability", and "maintainer" strings through into the generated HTML. If the module header doesn't match the pattern, then we don't include the info in the HTML.
Diffstat (limited to 'src/HaddockTypes.hs')
-rw-r--r--src/HaddockTypes.hs13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/HaddockTypes.hs b/src/HaddockTypes.hs
index c157a753..21ee513c 100644
--- a/src/HaddockTypes.hs
+++ b/src/HaddockTypes.hs
@@ -6,7 +6,7 @@
module HaddockTypes (
-- * Module interfaces
- NameEnv, Interface(..), ExportItem(..), ModuleMap,
+ NameEnv, Interface(..), ModuleInfo(..), ExportItem(..), ModuleMap,
-- * User documentation strings
DocString, GenDoc(..), Doc, ParsedDoc, DocMarkup(..),
@@ -49,15 +49,18 @@ data Interface
-- Includes not just "main names" but names of constructors,
-- record fields, etc.
- iface_portability :: String,
- iface_stability :: String,
- iface_maintainer :: String,
+ iface_info :: Maybe ModuleInfo,
-- ^ information from the module header
- iface_doc :: Maybe Doc
+ iface_doc :: Maybe Doc
-- ^ documentation from the module header
}
+data ModuleInfo = ModuleInfo
+ { portability :: String,
+ stability :: String,
+ maintainer :: String }
+
type DocString = String
data ExportItem