Data.API.Markdown

This module generates Markdown-formatted documentation for an API, like this:

 ###Foo

 a test defn

 JSON Type : **union object** (Haskell prefix is 'foo')

 | Alternative | Type    | Comment
 | ----------- | ------- | -----------
 | _`Baz`_     | boolean | just a bool
 | _`Qux`_     | integer | just an int

Documentation

markdown :: MarkdownMethods -> API -> MDComment

Create human-readable API documentation in Markdown format

data MarkdownMethods

Constructors

MDM

Fields

mdmSummaryPostfix :: TypeName -> MDComment

mdmLink :: TypeName -> MDComment

mdmPp :: MDComment -> MDComment -> MDComment

mdmFieldDefault :: FieldName -> APIType -> Maybe DefaultValue

defaultMarkdownMethods :: MarkdownMethods

thing :: MarkdownMethods -> Thing -> MDComment -> MDComment

Document a single API comment or node in Markdown format