Skip to content
Snippets Groups Projects
Commit 7e76c656 authored by David Waern's avatar David Waern
Browse files

Fix haddock comment errors in Haddock.Types

parent dfd8eac1
No related branches found
No related tags found
No related merge requests found
......@@ -22,29 +22,53 @@ data DocOption
deriving (Eq, Show)
data ExportItem name
= ExportDecl
Name -- ^ The original name
(LHsDecl name) -- ^ A declaration
(Maybe (HsDoc name)) -- ^ Maybe a doc comment
[InstHead name] -- ^ Instances relevant to this declaration
| ExportNoDecl -- ^ An exported entity for which we have no
-- documentation (perhaps because it resides in
-- another package)
Name -- ^ The original name
name -- ^ Where to link to
[name] -- ^ Subordinate names
| ExportGroup -- ^ A section heading
Int -- ^ section level (1, 2, 3, ... )
String -- ^ Section "id" (for hyperlinks)
(HsDoc name) -- ^ Section heading text
| ExportDoc -- ^ Some documentation
(HsDoc name)
| ExportModule -- ^ A cross-reference to another module
Module
= ExportDecl {
-- | The original name
expItemName :: Name,
-- | A declaration
expItemDecl :: LHsDecl name,
-- | Maybe a doc comment
expItemMbDoc :: Maybe (HsDoc name),
-- | Instances relevant to this declaration
expItemInstances :: [InstHead name]
} -- ^ An exported declaration
| ExportNoDecl {
-- | The original name
expItemName :: Name,
-- | Where to link to
expItemLinkTarget :: name,
-- | Subordinate names
expItemSubs :: [name]
} -- ^ An exported entity for which we have no
-- documentation (perhaps because it resides in
-- another package)
| ExportGroup {
-- | Section level (1, 2, 3, ... )
expItemSectionLevel :: Int,
-- | Section id (for hyperlinks)
expItemSectionId :: String,
-- | Section heading text
expItemSectionText :: HsDoc name
} -- ^ A section heading
| ExportDoc (HsDoc name) -- ^ Some documentation
| ExportModule Module -- ^ A cross-reference to another module
type InstHead name = ([HsPred name], name, [HsType name])
type ModuleMap = Map Module HaddockModule
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment