Safe Haskell	None
Language	Haskell2010

Data.API.Markdown

Description

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

Synopsis

Documentation

markdown :: MarkdownMethods -> API -> MDComment Source

Create human-readable API documentation in Markdown format

data MarkdownMethods Source

Constructors

MDM
Fields mdmSummaryPostfix :: TypeName -> MDComment mdmLink :: TypeName -> MDComment mdmPp :: MDComment -> MDComment -> MDComment mdmFieldDefault :: FieldName -> APIType -> Maybe DefaultValue

defaultMarkdownMethods :: MarkdownMethods Source

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

Document a single API comment or node in Markdown format