From d1f0e6ed1e271eb165abdecf7a5eae4f5c573ade Mon Sep 17 00:00:00 2001 From: Simon Hengel Date: Sun, 2 Nov 2014 13:10:58 +0800 Subject: Update documentation --- doc/haddock.xml | 44 ++++++++++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index 662aafd3..1fece5b3 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -2078,22 +2078,42 @@ This belongs to the list above!
URLs - A URL can be included in a documentation comment by - surrounding it in angle brackets: - <...>. If the output format supports - it, the URL will be turned into a hyperlink when - rendered. + + A URL can be included in a documentation comment by surrounding it in + angle brackets, for example: + - The URL can be followed by an optional label: -<http://example.com label> +<http://example.com> - The label is then used as a descriptive text for the hyperlink, if the - output format supports it. - If Haddock sees something that looks like a URL (such as something starting with - http:// or ssh://) where the URL markup is valid, - it will automatically make it a hyperlink. + + If the output format supports it, the URL will be turned into a + hyperlink when rendered. + + + If Haddock sees something that looks like a URL (such as something starting with + http:// or ssh://) where the URL markup is valid, + it will automatically make it a hyperlink. +
+ +
+ Links + + + 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: + + + +[some link](http://example.com) + + + The link text is used as a descriptive text for the URL, if the + output format supports it. +
-- cgit v1.2.3