diff options
| author | Kazu Yamamoto <kazu@iij.ad.jp> | 2013-02-01 11:59:24 +0900 |
|---|---|---|
| committer | Kazu Yamamoto <kazu@iij.ad.jp> | 2013-02-01 11:59:24 +0900 |
| commit | 8d4c94ca5a969a5ebbb791939fb0195dc672429e (patch) | |
| tree | 560a944a7105cd715f9acba46790bd7e1a77f82f /doc | |
| parent | 266a20afd2d27f28bbb62839ebc3f70bd83bfcce (diff) | |
| parent | 3d25ea2929a9a9bd0768339b8ac5fd1b7c4670ad (diff) | |
Merge branch 'ghc-7.6' into ghc-7.6-merge-2
Conflicts:
haddock.cabal
src/Haddock/Interface/AttachInstances.hs
src/Haddock/Interface/Create.hs
src/Haddock/Interface/LexParseRn.hs
src/Haddock/InterfaceFile.hs
src/Haddock/Types.hs
Only GHC HEAD can compile this. GHC 7.6.x cannot compile this.
Some test fail.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README | 1 | ||||
| -rw-r--r-- | doc/haddock.xml | 23 |
2 files changed, 22 insertions, 2 deletions
@@ -8,6 +8,7 @@ process the documentation on your system, and a Makefile to actually do the processing (so, on Windows, you'll need Cygwin or MSys in addition to the DocBook XML tools). To build the HTML documentation: + $ autoconf $ ./configure $ make html diff --git a/doc/haddock.xml b/doc/haddock.xml index 27dd69d8..139b2830 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -21,7 +21,7 @@ <holder>Simon Marlow, David Waern</holder> </copyright> <abstract> - <para>This document describes Haddock version 2.11.0, a Haskell + <para>This document describes Haddock version 2.13.2, a Haskell documentation tool.</para> </abstract> </bookinfo> @@ -1658,7 +1658,7 @@ module A where by zero or more result lines:</para> <programlisting> --- | Two examples are given bellow: +-- | Two examples are given below: -- -- >>> fib 10 -- 55 @@ -1672,6 +1672,18 @@ module A where generated documenation.</para> </section> + <section> + <title>Properties</title> + <para> + Haddock provides markup for properties: +<programlisting> +-- | Addition is commutative: +-- +-- prop> a + b = b + a +</programlisting> + This allows third-party applications to extract and verify them. + </para> + </section> <section> <title>Hyperlinked Identifiers</title> @@ -1830,6 +1842,13 @@ module A where <literal><...></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> +<http://example.com label> +</programlisting> + The label is then used as a descriptive text for the hyperlink, if the + output format supports it. </section> <section> |