Text.Docs.Class
Description
Classes for Documentable types.
- class Documentable a where
- emptydoc :: Documentable a => a
- dunlines :: Documentable a => [a] -> a
- class Documentable a => DocTitled a where
- class Documentable a => DocLinked a where
- class Documentable a => DocList a where
Documentable class
class Documentable a whereSource
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
String to a documentation text.
String to a code format text.
codeblock :: String -> aSource
String to a code block.
Emphasizing documentation.
Appending documentation.
Appending documentation, with line break.
renderdoc :: a -> StringSource
Rendering documentation.
Instances
emptydoc :: Documentable a => aSource
An empty documentation.
dunlines :: Documentable a => [a] -> aSource
Documentable version of unlines.
Specific Documentable class.
class Documentable a => DocTitled a whereSource
Documentable types with titles.
class Documentable a => DocLinked a whereSource
Documentable types with links.
class Documentable a => DocList a whereSource
Documentable types with lists.