haskell-docs-cli-1.0.0.0: Search Hoogle and navigate Hackage from the command line.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Docs.CLI.Haddock

Description

Functions to parse and display Haddock HTML

Synopsis

Documentation

data Html Source #

An html element

Instances

Instances details
Show Html Source # 
Instance details

Defined in Docs.CLI.Haddock

Methods

showsPrec :: Int -> Html -> ShowS #

show :: Html -> String #

showList :: [Html] -> ShowS #

Eq Html Source # 
Instance details

Defined in Docs.CLI.Haddock

Methods

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

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

data HtmlPage Source #

The root of an html page

data Declaration Source #

An exported declaration

Constructors

Declaration 

Fields

Instances

Instances details
HasCompletion Declaration Source # 
Instance details

Defined in Docs.CLI.Haddock

data Module Source #

Instances

Instances details
HasCompletion Module Source # 
Instance details

Defined in Docs.CLI.Haddock

data Package Source #

Instances

Instances details
HasCompletion Package Source # 
Instance details

Defined in Docs.CLI.Haddock

fileInfo :: SourceLink -> HtmlPage -> FileInfo Source #

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

class HasCompletion a where Source #

Types that can be selected with tab completion

Methods

completion :: a -> String Source #

Instances

Instances details
HasCompletion Declaration Source # 
Instance details

Defined in Docs.CLI.Haddock

HasCompletion Module Source # 
Instance details

Defined in Docs.CLI.Haddock

HasCompletion Package Source # 
Instance details

Defined in Docs.CLI.Haddock

HasCompletion Item Source # 
Instance details

Defined in Docs.CLI.Hoogle

HasCompletion String Source # 
Instance details

Defined in Docs.CLI.Haddock

HasCompletion a => HasCompletion (NonEmpty a) Source # 
Instance details

Defined in Docs.CLI.Haddock

prettyHtml :: IsHtml html => html -> Doc Source #

Render Haddock's Html

numbered :: [Doc] -> [Doc] Source #