Safe Haskell | None |
---|---|
Language | Haskell98 |
Haskell.Docs.Types
Description
All types.
Synopsis
- data IdentDoc = IdentDoc {
- identDocPackageName :: !PkgID
- identDocIdentifier :: !Identifier
- identDocModuleName :: !ModuleName
- identDocDocs :: !(Doc String)
- identDocIdent :: !(Maybe Id)
- identDocArgDocs :: !(Maybe [(Int, Doc String)])
- data DocsException
- newtype Identifier = Identifier {}
- newtype PackageName = PackageName String
- type PkgID = UnitId
Documentation
Identier documentation along with argument docs and identifiers.
Constructors
IdentDoc | |
Fields
|
data DocsException Source #
An exception when doing lookups.
Constructors
NoFindModule | |
PackageLookupFailed !Text | |
NoModulePackageCombo | |
NoInterfaceFiles | |
NoParseInterfaceFiles [DocsException] | |
NoFindNameInExports | |
NoFindNameInInterface | |
NoReadInterfaceFile String |
Instances
Show DocsException Source # | |
Defined in Haskell.Docs.Types Methods showsPrec :: Int -> DocsException -> ShowS # show :: DocsException -> String # showList :: [DocsException] -> ShowS # | |
Exception DocsException Source # | |
Defined in Haskell.Docs.Types Methods toException :: DocsException -> SomeException # fromException :: SomeException -> Maybe DocsException # displayException :: DocsException -> String # |
newtype Identifier Source #
An identifier.
Constructors
Identifier | |
Fields |
Instances
Eq Identifier Source # | |
Defined in Haskell.Docs.Types | |
Show Identifier Source # | |
Defined in Haskell.Docs.Types Methods showsPrec :: Int -> Identifier -> ShowS # show :: Identifier -> String # showList :: [Identifier] -> ShowS # |
newtype PackageName Source #
An package name.
Constructors
PackageName String |
Instances
Eq PackageName Source # | |
Defined in Haskell.Docs.Types | |
Show PackageName Source # | |
Defined in Haskell.Docs.Types Methods showsPrec :: Int -> PackageName -> ShowS # show :: PackageName -> String # showList :: [PackageName] -> ShowS # |