diff options
| author | Niklas Haas <git@nand.wakku.to> | 2014-03-11 09:11:21 +0100 |
|---|---|---|
| committer | Niklas Haas <git@nand.wakku.to> | 2014-03-11 10:26:05 +0100 |
| commit | b9995041b5c838d41ba14ff684d9f5bfacd9ffc4 (patch) | |
| tree | 0a6f8f67acae211a0c52ad614fddfd735129fe0f | |
| parent | b8efaf4ead90c5c95367cc479da522b820b5004e (diff) | |
Add documentation for --source-entity-line
| -rw-r--r-- | doc/haddock.xml | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml index 5bc27aca..da0c5457 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -539,6 +539,10 @@ $ pdflatex <replaceable>package</replaceable>.tex</screen> <indexterm><primary><option>--source-entity</option></primary></indexterm> <option>--source-entity</option>=<replaceable>URL</replaceable> </term> + <term> + <indexterm><primary><option>--source-entity-line</option></primary></indexterm> + <option>--source-entity-line</option>=<replaceable>URL</replaceable> + </term> <listitem> <para>Include links to the source files in the generated documentation. Use the <option>--source-base</option> option to add a @@ -547,6 +551,9 @@ $ pdflatex <replaceable>package</replaceable>.tex</screen> the header bar of each module page. Use the <option>--source-entity</option> option to add a source code link next to the documentation for every value and type in each module. + <option>--source-entity-line</option> is a flag that gets used for + entities that need to link to an exact source location rather than a + name, eg. since they were defined inside a Template Haskell splice. </para> <para>In each case <replaceable>URL</replaceable> is the base URL |