Docs.CLI.Haddock

Functions to parse and display Haddock HTML

Documentation

data Html

An html element

Instances

Show Html

Defined in Docs.CLI.Haddock

Methods

showsPrec :: Int -> Html -> ShowS

show :: Html -> String

showList :: [Html] -> ShowS

Eq Html

Defined in Docs.CLI.Haddock

Methods

(==) :: Html -> Html -> Bool

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

data HtmlPage

The root of an html page

data Declaration

An exported declaration

Constructors

Declaration

Fields

• dAnchors :: Set Anchor
• dAnchor :: Anchor

  Main declaration anchor

• dSignature :: Html
• dSignatureExpanded :: Html

  Signature with argument documentation, if available.

• dContent :: [Html]
• dModuleUrl :: ModuleUrl
• dDeclUrl :: DeclUrl
• dCompletion :: String

  string to be used when selecting this declaration with tab completion

Instances

HasCompletion Declaration

Defined in Docs.CLI.Haddock

Methods

completion :: Declaration -> String

data Module

Constructors

Module

Fields

• mTitle :: String
• mDescription :: Maybe Html
• mDeclarations :: [Declaration]
• mUrl :: ModuleUrl

Instances

HasCompletion Module

Defined in Docs.CLI.Haddock

Methods

completion :: Module -> String

data Package

Constructors

Package

Fields

• pTitle :: String
• pSubTitle :: Maybe String
• pDescription :: Html
• pReadme :: Maybe Html
• pProperties :: [(String, Html)]
• pModules :: [String]
• pUrl :: PackageUrl

Instances

HasCompletion Package

Defined in Docs.CLI.Haddock

Methods

completion :: Package -> String

parseHtmlDocument :: ByteString -> HtmlPage

parseModuleDocs :: ModuleUrl -> HtmlPage -> Module

parsePackageDocs :: PackageUrl -> HtmlPage -> Package

sourceLinks :: ModuleUrl -> HtmlPage -> [(Anchor, SourceLink)]

fileInfo :: SourceLink -> HtmlPage -> FileInfo

Convert an html page into a src file and inform of line number of SourceLink

class HasCompletion a where

Types that can be selected with tab completion

Methods

completion :: a -> String

Instances

HasCompletion Declaration

Defined in Docs.CLI.Haddock

Methods

completion :: Declaration -> String

HasCompletion Module

Defined in Docs.CLI.Haddock

Methods

completion :: Module -> String

HasCompletion Package

Defined in Docs.CLI.Haddock

Methods

completion :: Package -> String

HasCompletion Item

Defined in Docs.CLI.Hoogle

Methods

completion :: Item -> String

HasCompletion String

Defined in Docs.CLI.Haddock

Methods

completion :: String -> String

HasCompletion a => HasCompletion (NonEmpty a)

Defined in Docs.CLI.Haddock

Methods

completion :: NonEmpty a -> String

innerString :: Html -> String

prettyHtml :: IsHtml html => html -> Doc

Render Haddock's Html

numbered :: [Doc] -> [Doc]

parseHoogleHtml :: String -> Html

link :: Doc -> Doc