[Haskell-cafe] ANNOUNCE: Haddock version

David Waern david.waern at gmail.com
Tue Jan 8 07:28:50 EST 2008

Dear Haskell community,

I'm proud to announce the release of Haddock!


Changes in version

  * The GHC API is used as the front-end

  * Haddock now understands all syntax understood by GHC 6.8.2

  * Haddock can generate documentation for some of the language extensions
    in GHC 6.8.2

  * Format of module attributes has changed. The only way of specifiying
    module attributes is via a new OPTIONS_HADDOCK pragma. Example:
    {-# OPTIONS_HADDOCK hide, prune #-}

  * Haddock understands literate source files

  * Add a small library to read Haddock's interface files

  * Add a flag -B for passing the path to the GHC lib dir

  * Add a flag --optghc for passing options to GHC

  * Add a flag --ghc-version for printing the GHC version

  * Remove --use-package, --allow-missing-html, --ghc-pkg, in favour of only
    supporting --read-interface

  * Remove --package flag, the GHC flag -package-name can be used instead

  * Remove --no-implicit-prelude flag, the GHC flag -XNoImplicitPrelude can
    be used instead

  * Hoogle support temporarily removed

It should be noted that this version of Haddock is not compatible with
interface files from previous versions.

Also, currently, when Haddock comes across a GHC language extension
that it doesn't know how to render as HTML, it will bail out. If this
happens to you, bug me about it, or help out by sending a patch.

On the development side, Haddock has been slightly refactored for
easier code navigation, and has the beginnings of a test suite.

Haddock also ships with (as noted in the list of changes) a small,
experimental library that can be used to read its interface files.
Tools and IDE-type applications can use this library to e.g. look up
the documentation for identifiers.

The code repository is at http://code.haskell.org/haddock.


More information about the Haskell-Cafe mailing list