headers
Ashley Yakeley | 22 Dec 2003 03:30

Standard Library Haddock-Interfaces?

Consider this:

  module M (Monoid(..)) where
  {
  import Control.Monad.Monoid;
  }

I'd like Haddock to show documentation for Monoid in module M (for 
instance). Are there standard Haddock-interfaces for the standard 
libraries? Or should I generate them myself, and if so, should I use the 
ghc6-libsrc package, or should I check out some tag in CVS?

--

-- 
Ashley Yakeley, Seattle WA
Permalink | Reply | 0 comments |
headers
Simon Marlow | 22 Dec 2003 10:47
Picon
Favicon

RE: Standard Library Haddock-Interfaces?


> Consider this:
> 
>   module M (Monoid(..)) where
>   {
>   import Control.Monad.Monoid;
>   }
> 
> I'd like Haddock to show documentation for Monoid in module M (for 
> instance).

Unfortunately this isn't possible.  Haddock can produce documentation
with hyperlinks to entities in another package, but it cannot include
full documentation for entities which are re-expored from a different
package.  This would require essentially keeping a copy of the entire
documentation for the package in the interface file.

> Are there standard Haddock-interfaces for the standard 
> libraries?

A GHC distribution comes with Haddock interfaces for all the packages
that it ships with.

Cheers,
	Simon
Permalink | Reply | 1 comment |
headers
Ashley Yakeley | 24 Dec 2003 06:25

Re: Standard Library Haddock-Interfaces?

In article 
<3429668D0E777A499EE74A7952C382D10146A9DA <at> EUR-MSG-01.europe.corp.microso
ft.com>,
 "Simon Marlow" <simonmar <at> microsoft.com> wrote:

> Unfortunately this isn't possible.  Haddock can produce documentation
> with hyperlinks to entities in another package, but it cannot include
> full documentation for entities which are re-expored from a different
> package.  This would require essentially keeping a copy of the entire
> documentation for the package in the interface file.

So what is stored in a Haddock interface file?

> > Are there standard Haddock-interfaces for the standard 
> > libraries?
> 
> A GHC distribution comes with Haddock interfaces for all the packages
> that it ships with.

Where? In the Debian package ghc 6.2-0.woody.1 I can only find the .hi 
files, and that's not the same thing, is it?

--

-- 
Ashley Yakeley, Seattle WA
Permalink | Reply | 0 comments |

Gmane