From af85d14f001cf4c2976ee659ec04101d6b054a4d Mon Sep 17 00:00:00 2001
From: Simon Hengel <sol@typeful.net>
Date: Sun, 2 Nov 2014 13:54:19 +0800
Subject: Add support for markdown images

---
 doc/haddock.xml | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

(limited to 'doc')

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>&lt;&lt;...&gt;&gt;</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>
-&lt;&lt;pathtoimage.png title&gt;&gt;
+![image description](pathtoimage.png)
 </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>
-- 
cgit v1.2.3