diff options
| author | Łukasz Hanuszczak <lukasz.hanuszczak@gmail.com> | 2015-07-04 16:28:26 +0200 |
|---|---|---|
| committer | Łukasz Hanuszczak <lukasz.hanuszczak@gmail.com> | 2015-07-04 16:28:26 +0200 |
| commit | 9c156cdcfd7d042ed9cfa242871846291af5cf0a (patch) | |
| tree | 0a89ef4cae761ecb4cdc222bb86e79cc6a45813a /doc/haddock.xml | |
| parent | 29bb1ce86e12b368c4eb91dbf515391a0958b8c3 (diff) | |
Update docs with information about source hyperlinking.
Diffstat (limited to 'doc/haddock.xml')
| -rw-r--r-- | doc/haddock.xml | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml index b528fdb5..6c83f618 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -530,6 +530,43 @@ $ pdflatex <replaceable>package</replaceable>.tex</screen> <varlistentry> <term> + <indexterm><primary><option>--hyperlinked-source</option></primary></indexterm> + <option>--hyperlinked-source</option> + </term> + <listitem> + <para>Generate hyperlinked source code (as HTML web page). All + rendered files will be put into + <filename class='directory'>src/</filename> subfolder of output + directory.</para> + <para>Usually, this should be used in combination with + <option>--html</option> option - generated documentation will then + contain references to appropriate code fragments. Previously, this + behaviour could be achieved by generating sources using external + tool and specifying <option>--source-base</option>, + <option>--source-module</option>, <option>--source-entity</option> + and related options. Note that these flags are ignored once + <option>--hyperlinked-source</option> is set.</para> + <para>In order to make cross-package source hyperlinking possible, + appropriate source paths have to be set up when providing + interface files using <option>--read-interface</option> + option.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <indexterm><primary><option>--source-style</option></primary></indexterm> + <option>--source-style=<replaceable>style</replaceable></option> + </term> + <listitem> + <para>Use custom CSS file for sources rendered by the + <option>--hyperlinked-source</option> option. If no custom style + file is provided, Haddock will use default one.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> <indexterm><primary><option>-S</option></primary></indexterm> <option>-S</option> </term> |