[commit: haddock] T6018-injective-type-families, adamse-D1033, ghc-head, master, metainfo, wip/10268, wip/10313, wip/D538, wip/D538-1, wip/D538-2, wip/D538-3, wip/D538-4, wip/D538-5, wip/D538-6, wip/D548-master, wip/D548-master-2, wip/T10483, wip/T9840, wip/api-annot-tweaks-7.10, wip/api-annots-ghc-7.10-3, wip/orf-reboot: Update documentation (d1f0e6e)

git at git.haskell.org git at git.haskell.org
Wed Jul 8 08:32:30 UTC 2015


Repository : ssh://git@git.haskell.org/haddock

On branches: T6018-injective-type-families,adamse-D1033,ghc-head,master,metainfo,wip/10268,wip/10313,wip/D538,wip/D538-1,wip/D538-2,wip/D538-3,wip/D538-4,wip/D538-5,wip/D538-6,wip/D548-master,wip/D548-master-2,wip/T10483,wip/T9840,wip/api-annot-tweaks-7.10,wip/api-annots-ghc-7.10-3,wip/orf-reboot
Link       : http://git.haskell.org/haddock.git/commitdiff/d1f0e6ed1e271eb165abdecf7a5eae4f5c573ade

>---------------------------------------------------------------

commit d1f0e6ed1e271eb165abdecf7a5eae4f5c573ade
Author: Simon Hengel <sol at typeful.net>
Date:   Sun Nov 2 13:10:58 2014 +0800

    Update documentation


>---------------------------------------------------------------

d1f0e6ed1e271eb165abdecf7a5eae4f5c573ade
 doc/haddock.xml | 44 ++++++++++++++++++++++++++++++++------------
 1 file changed, 32 insertions(+), 12 deletions(-)

diff --git a/doc/haddock.xml b/doc/haddock.xml
index 662aafd..1fece5b 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -2078,22 +2078,42 @@ This belongs to the list above!
       <section>
         <title>URLs</title>
 
-        <para>A URL can be included in a documentation comment by
-        surrounding it in angle brackets:
-        <literal><...></literal>.  If the output format supports
-        it, the URL will be turned into a hyperlink when
-        rendered.</para>
+        <para>
+          A URL can be included in a documentation comment by surrounding it in
+          angle brackets, for example:
+        </para>
 
-        <para>The URL can be followed by an optional label:</para>
 <programlisting>
-<http://example.com label>
+<http://example.com>
 </programlisting>
-      <para>The label is then used as a descriptive text for the hyperlink, if the
-        output format supports it.</para>
 
-      <para>If Haddock sees something that looks like a URL (such as something starting with
-      <literal>http://</literal> or <literal>ssh://</literal>) where the URL markup is valid,
-      it will automatically make it a hyperlink.</para>
+        <para>
+          If the output format supports it, the URL will be turned into a
+          hyperlink when rendered.
+        </para>
+
+        <para>If Haddock sees something that looks like a URL (such as something starting with
+        <literal>http://</literal> or <literal>ssh://</literal>) where the URL markup is valid,
+        it will automatically make it a hyperlink.</para>
+      </section>
+
+      <section>
+        <title>Links</title>
+
+        <para>
+          Haddock supports Markdown syntax for inline links.  A link consists
+          of a link text and a URL.  The link text is enclosed in square
+          brackets and followed by the URL enclosed in regular parentheses, for
+          example:
+        </para>
+
+<programlisting>
+[some link](http://example.com)
+</programlisting>
+        <para>
+          The link text is used as a descriptive text for the URL, if the
+          output format supports it.
+        </para>
       </section>
 
       <section>



More information about the ghc-commits mailing list