diff options
| author | Simon Hengel <sol@typeful.net> | 2014-11-02 13:54:19 +0800 |
|---|---|---|
| committer | Simon Hengel <sol@typeful.net> | 2014-11-03 09:34:20 +0800 |
| commit | af85d14f001cf4c2976ee659ec04101d6b054a4d (patch) | |
| tree | a1008160996b873ff5e78512ad9e679aee3b9a39 /doc/haddock.xml | |
| parent | d1f0e6ed1e271eb165abdecf7a5eae4f5c573ade (diff) | |
Add support for markdown images
Diffstat (limited to 'doc/haddock.xml')
| -rw-r--r-- | doc/haddock.xml | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml index 1fece5b3..ee77ede9 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -2118,17 +2118,20 @@ This belongs to the list above! <section> <title>Images</title> + <para> + Haddock supports Markdown syntax for inline images. This resembles + the syntax for links, but starts with an exclamation mark. An + example looks like this: + </para> - <para>An image can be included in a documentation comment by - surrounding it in double angle brackets: - <literal><<...>></literal>. If the output format supports - it, the image will be rendered inside the documentation.</para> - - <para>Title text can be included using an optional label:</para> <programlisting> -<<pathtoimage.png title>> + </programlisting> - + <para> + If the output format supports it, the image will be rendered inside + the documentation. The image description is used as relpacement text + and/or image title. + </para> </section> <section> |