aboutsummaryrefslogtreecommitdiff
path: root/doc/haddock.xml
diff options
context:
space:
mode:
authorSimon Hengel <sol@typeful.net>2012-09-08 12:17:17 +0200
committerSimon Hengel <sol@typeful.net>2012-09-08 12:17:17 +0200
commit0f6c13f66ea335bf371ab49125371ac665de6cf8 (patch)
treef8d8f4e1ef50e53d968a1be48cfa6a31090d2463 /doc/haddock.xml
parentff2e024f737017d32e3dc39a7ab2322d54e56ca3 (diff)
Add documentation for URL labels
Diffstat (limited to 'doc/haddock.xml')
-rw-r--r--doc/haddock.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml
index 7ddfdccd..a38b70cf 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -1830,6 +1830,13 @@ module A where
<literal>&lt;...&gt;</literal>. If the output format supports
it, the URL will be turned into a hyperlink when
rendered.</para>
+
+ The URL can be followed by an optional label:
+<programlisting>
+&lt;http://example.com label&gt;
+</programlisting>
+ The label is then used as a descriptive text for the hyperlink, if the
+ output format supports it.
</section>
<section>