Text.Docs.Class

Classes for Documentable types.

Documentable class

class Documentable a where

Class for types that represents a documentation text. Minimal complete definition: All except lnappend.

Every instance of Documentable class can be an instance of Monoid class.

Methods

text :: String -> a

String to a documentation text.

code :: String -> a

String to a code format text.

codeblock :: String -> a

String to a code block.

emphasize :: a -> a

Emphasizing documentation.

dappend :: a -> a -> a

Appending documentation.

lnappend :: a -> a -> a

Appending documentation, with line break.

renderdoc :: a -> String

Rendering documentation.

Instances

Documentable Html

emptydoc :: Documentable a => a

An empty documentation.

dunlines :: Documentable a => [a] -> a

Documentable version of unlines.

Specific Documentable class.

class Documentable a => DocTitled a where

Documentable types with titles.

Methods

title :: a -> a

Making a title.

subtitle :: a -> a

Making a subtitle.

Instances

DocTitled Html

class Documentable a => DocLinked a where

Documentable types with links.

Methods

url :: String -> a

An URL to documentation.

nameurl :: String -> String -> a

A named URL to documentation. First argument is the name of the link, second argument the URL.

Instances

DocLinked Html

class Documentable a => DocList a where

Documentable types with lists.

Methods

ulist :: [a] -> a

Unordered list.

elist :: [a] -> a

Enumerated list.

Instances

DocList Html