./wip/haddock, Documentation tool for Haskell

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]


Branch: CURRENT, Version: 0.8nb1, Package name: haddock-0.8nb1, Maintainer: esg

Haddock is a tool for automatically generating documentation from
annotated Haskell source code. It is primarily intended for documenting
libraries, but it should be useful for any kind of Haskell code.

Like other systems, Haddock lets you write documentation annotations
next to the definitions of functions and types in the source code, in a
syntax that is easy on the eye when writing the source code (no
heavyweight mark-up). The documentation generated by Haddock is fully
hyperlinked - click on a type name in a type signature to go straight to
the definition, and documentation, for that type.


Required to run:
[devel/gmp]

Required to build:
[lang/ghc] [pkgtools/cwrappers]

Master sites:


Version history: (Expand)


CVS history: (Expand)


   2012-09-29 19:05:52 by Aleksej Saushev | Files touched by this commit (30)
Log message:
Drop superfluous PKG_DESTDIR_SUPPORT, "user-destdir" is default these days.
Mark packages that don't or might probably not have staged installation.
   2011-01-17 11:48:03 by Emil Sköldberg | Files touched by this commit (17)
Log message:
Update maintainer email address to valid address.
   2009-10-11 12:44:40 by Thomas Klausner | Files touched by this commit (286)
Log message:
Remove obsolete @dirrm lines.
   2009-05-20 02:58:40 by Thomas Klausner | Files touched by this commit (75) | Package updated
Log message:
Recursive ABI depends update and PKGREVISION bump for readline-6.0 shlib
major change.

Reported by Robert Elz in PR 41345.
   2006-10-17 15:35:10 by Emil Sköldberg | Files touched by this commit (3)
Log message:
Update to version 0.8.

Changes in version 0.8:

  * Haddock has a Cabal build system, and will build on Windows without
    Cygwin or MSYS.  GHC 6.4 or later is required.

  * New options: --comments-base, --comments-module, --comments-entity
    for generating links to pages (eg. wiki) for collecting user comments.

  * New options: --source-base, --source-module, --source-entity
    for generating links to source code.  Haddock now understands
    {-# LINE #-} pragmas, which means it can figure out the correct
    name for the source file even if the file is preprocessed.

  * Haddock generates output for populating the Hoogle search engine.

  * New markup <<url>> for including images.
   2006-08-25 16:08:23 by Emil Sköldberg | Files touched by this commit (1)
Log message:
Added perl to USE_TOOLS.
Fixed a pkglint warning by unhiding a 'cd'.
   2005-11-17 15:05:34 by Emil Sköldberg | Files touched by this commit (2)
Log message:
* Fixed DISTNAME.
* Introduced the VERSION variable.
   2005-11-14 17:28:48 by Emil Sköldberg | Files touched by this commit (4) | Imported package
Log message:
Haddock is a tool for automatically generating documentation from
annotated Haskell source code. It is primarily intended for documenting
libraries, but it should be useful for any kind of Haskell code.

Like other systems, Haddock lets you write documentation annotations
next to the definitions of functions and types in the source code, in a
syntax that is easy on the eye when writing the source code (no
heavyweight mark-up). The documentation generated by Haddock is fully
hyperlinked - click on a type name in a type signature to go straight to
the definition, and documentation, for that type.