diff options
Diffstat (limited to 'src/HaddockTypes.hs')
| -rw-r--r-- | src/HaddockTypes.hs | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/HaddockTypes.hs b/src/HaddockTypes.hs index f99d2893..5af102d4 100644 --- a/src/HaddockTypes.hs +++ b/src/HaddockTypes.hs @@ -7,6 +7,7 @@ module HaddockTypes ( -- * Module interfaces NameEnv, Interface(..), ModuleInfo(..), ExportItem(..), ModuleMap, + DocOption(..), -- * User documentation strings DocString, GenDoc(..), Doc, ParsedDoc, DocMarkup(..), @@ -52,8 +53,11 @@ data Interface iface_info :: Maybe ModuleInfo, -- ^ information from the module header - iface_doc :: Maybe Doc + iface_doc :: Maybe Doc, -- ^ documentation from the module header + + iface_options :: [DocOption] + -- ^ module-wide doc options } data ModuleInfo = ModuleInfo @@ -61,6 +65,9 @@ data ModuleInfo = ModuleInfo stability :: String, maintainer :: String } +data DocOption = OptHide | OptPrune | OptIgnoreExports + deriving (Eq) + type DocString = String data ExportItem @@ -75,6 +82,9 @@ data ExportItem | ExportDoc -- some documentation Doc + | ExportModule -- a cross-reference to another module + Module + type ModuleMap = FiniteMap Module Interface -- ----------------------------------------------------------------------------- |