Haskell.Docs.Types

All types.

Documentation

data IdentDoc

Identier documentation along with argument docs and identifiers.

Constructors

IdentDoc

Fields

• identDocPackageName :: !PkgID
• identDocIdentifier :: !Identifier
• identDocModuleName :: !ModuleName
• identDocDocs :: !(Doc String)
• identDocIdent :: !(Maybe Id)
• identDocArgDocs :: !(Maybe [(Int, Doc String)])

Instances

Eq IdentDoc

Defined in Haskell.Docs.Types

Methods

(==) :: IdentDoc -> IdentDoc -> Bool

(/=) :: IdentDoc -> IdentDoc -> Bool

data DocsException

An exception when doing lookups.

Constructors

NoFindModule

PackageLookupFailed !Text

NoModulePackageCombo

NoInterfaceFiles

NoParseInterfaceFiles [DocsException]

NoFindNameInExports

NoFindNameInInterface

NoReadInterfaceFile String

Instances

Show DocsException

Defined in Haskell.Docs.Types

Methods

showsPrec :: Int -> DocsException -> ShowS

show :: DocsException -> String

showList :: [DocsException] -> ShowS

Exception DocsException

Defined in Haskell.Docs.Types

Methods

toException :: DocsException -> SomeException

fromException :: SomeException -> Maybe DocsException

displayException :: DocsException -> String

newtype Identifier

An identifier.

Constructors

Identifier

Fields

• unIdentifier :: String

Instances

Eq Identifier

Defined in Haskell.Docs.Types

Methods

(==) :: Identifier -> Identifier -> Bool

(/=) :: Identifier -> Identifier -> Bool

Show Identifier

Defined in Haskell.Docs.Types

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

newtype PackageName

An package name.

Constructors

PackageName String

Instances

Eq PackageName

Defined in Haskell.Docs.Types

Methods

(==) :: PackageName -> PackageName -> Bool

(/=) :: PackageName -> PackageName -> Bool

Show PackageName

Defined in Haskell.Docs.Types

Methods

showsPrec :: Int -> PackageName -> ShowS

show :: PackageName -> String

showList :: [PackageName] -> ShowS

type PkgID = UnitId