diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/invoking.rst | 4 | ||||
| -rw-r--r-- | doc/markup.rst | 13 |
2 files changed, 5 insertions, 12 deletions
diff --git a/doc/invoking.rst b/doc/invoking.rst index 68e01d70..4b7f987c 100644 --- a/doc/invoking.rst +++ b/doc/invoking.rst @@ -58,6 +58,7 @@ The following options are available: --read-interface=<docpath>,<file> -i <docpath>,<srcpath>,<file> --read-interface=<docpath>,<srcpath>,<file> + -i <docpath>,<srcpath>,<visibility>,<file> Read the interface file in file, which must have been produced by running Haddock with the :option:`--dump-interface` option. The interface @@ -77,6 +78,9 @@ The following options are available: hyperlinks but within sources rendered with :option:`--hyperlinked-source` option. + If visibility is set to `hidden`, modules from that interface file will + not be listed in haddock generated content file. + Multiple :option:`--read-interface` options may be given. .. option:: -D <file> diff --git a/doc/markup.rst b/doc/markup.rst index abfeb52a..55ae3cb3 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -178,7 +178,7 @@ Deriving clauses Most instances are top-level, so can be documented as in :ref:`top-level-declaration`. The exception to this is instance that are come from a ``deriving`` clause on a datatype declaration. These can -the documented like this: :: +be documented like this: :: data D a = L a | M deriving ( Eq -- ^ @since 4.5 @@ -1126,17 +1126,6 @@ followed by the URL enclosed in regular parentheses, for example: :: The link text is used as a description for the URL if the output format supports it. - -Hint: There's a `known issue <https://github.com/haskell/haddock/issues/774>`_ -that any inline link at the beginning of a line within a multi-line comment -isn't rendered correctly: :: - - {-| Some multi-line comment that has a - [link](https://example.com) and a - [reference link]: https://example.com - -} - -Adding a space or a word in front of such a link can be used as a workaround. Images ~~~~~~ |