Documentatio markup

[Manuel M. T. Chakravarty]

Simon Marlow <simonmar@microsoft.com> wrote,

> The real problem is that you need at least three forms of hyperlinked
> markup:  eg, what should @ForeignPtr@ link to - the type constructor,
> the constructor, or the module?  I suppose there's always @...@, |...|,
> <...>, <<...>>, etc.
> 
> Would this be too heavyweight: @module M@, @con C@, @class C@, @tycon
> T@?  Perhaps the keywords could be left out when the meaning is
> non-ambiguous, as is usually the case with variable and function names.

In the case where a name is actually ambigious it may be
acceptable.  However, it must be possible to omit the
additional information when the name is uniquely defining an
entity.

Cheers,
Manuel