Skip to content
Snippets Groups Projects
Commit b0b1f89f authored by simonmar's avatar simonmar
Browse files

[haddock @ 2002-05-15 13:16:07 by simonmar]

- Remove the note about function argument docs not being implemented

- Note that qualified identifiers can be used to point to entities
  that aren't in scope.
parent fead183e
No related branches found
No related tags found
No related merge requests found
...@@ -532,9 +532,6 @@ f :: Int -- ^ The 'Int' argument ...@@ -532,9 +532,6 @@ f :: Int -- ^ The 'Int' argument
-> Float -- ^ The 'Float' argument -> Float -- ^ The 'Float' argument
-> IO () -- ^ The return value -> IO () -- ^ The return value
</programlisting> </programlisting>
<para>NOTE: this feature isn't implemented in Haddock
0.2.</para>
</section> </section>
</section> </section>
...@@ -924,6 +921,20 @@ module A where ...@@ -924,6 +921,20 @@ module A where
hyperlinking, of course; in a printed format it might instead hyperlinking, of course; in a printed format it might instead
insert a page reference to the definition).</para> insert a page reference to the definition).</para>
<para>It is also possible to refer to entities that are not in
scope in the current module, by giving the full qualified name
of the entity:</para>
<programlisting>
-- | The identifier 'M.T' is not in scope
</programlisting>
<para>If <literal>M.T</literal> is not otherwise in scope,
then Haddock will simply emit a link pointing to the entity
<literal>T</literal> exported from module <literal>M</literal>
(without checking to see whether either <literal>M</literal>
or <literal>M.T</literal> exist).</para>
<para>For compatibility with other systems, the following <para>For compatibility with other systems, the following
alternative form of markup is accepted<footnote><para> alternative form of markup is accepted<footnote><para>
We chose not to use this as the primary markup for We chose not to use this as the primary markup for
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment