From b0b1f89f48ab02ad2542d2fab476dc8b09bbf2b8 Mon Sep 17 00:00:00 2001 From: simonmar Date: Wed, 15 May 2002 13:16:07 +0000 Subject: [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. --- doc/haddock.sgml | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/doc/haddock.sgml b/doc/haddock.sgml index 74128baa..c90e0f01 100644 --- a/doc/haddock.sgml +++ b/doc/haddock.sgml @@ -532,9 +532,6 @@ f :: Int -- ^ The 'Int' argument -> Float -- ^ The 'Float' argument -> IO () -- ^ The return value - - NOTE: this feature isn't implemented in Haddock - 0.2. @@ -924,6 +921,20 @@ module A where hyperlinking, of course; in a printed format it might instead insert a page reference to the definition). + 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: + + +-- | The identifier 'M.T' is not in scope + + + If M.T is not otherwise in scope, + then Haddock will simply emit a link pointing to the entity + T exported from module M + (without checking to see whether either M + or M.T exist). + For compatibility with other systems, the following alternative form of markup is accepted We chose not to use this as the primary markup for -- cgit v1.2.3