diff options
Diffstat (limited to 'doc/haddock.xml')
| -rw-r--r-- | doc/haddock.xml | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml index c027170c..ca49bf38 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -477,7 +477,25 @@ <listitem> <para>Include links to the source files in the generated documentation, where <replaceable>URL</replaceable> is the - base URL where the source files can be found.</para> + base URL where the source files can be found. The following + substitutions are made within the string + <replaceable>URL</replaceable>:</para> + + <itemizedlist> + <listitem> + <para>The string <literal>%M</literal> is replaced by the module name + (with ‘.’ replaced by ‘/’).</para> + </listitem> + <listitem> + <para>The string <literal>%F</literal> is replaced by the + source file name.</para> + </listitem> + </itemizedlist> + + <para>For example, if your sources are online in a single directory, + you would say <literal>haddock -s + <replaceable>url</replaceable>/%F</literal>.</para> + </listitem> </varlistentry> |