haddock: A documentation-generation tool for Haskell libraries

[ bsd3, documentation, program ] [ Propose Tags ]

Haddock is a documentation-generation tool for Haskell libraries


[Skip to Readme]
Versions 0.8, 0.9, 2.0.0.0, 2.1.0, 2.2.0, 2.2.1, 2.2.2, 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.6.0, 2.6.1, 2.7.0, 2.7.1, 2.7.2, 2.8.0, 2.8.1, 2.9.0, 2.9.1, 2.9.2, 2.9.3, 2.9.4, 2.10.0, 2.11.0, 2.11.1, 2.12.0, 2.13.0, 2.13.1, 2.13.2, 2.13.2.1, 2.14.1, 2.14.2, 2.14.3, 2.15.0, 2.15.0.1, 2.15.0.2, 2.16.0, 2.16.1, 2.17.2, 2.17.4, 2.17.5, 2.18.1, 2.19.0.1, 2.20.0
Change log CHANGES
Dependencies base (>=4.3 && <4.8), haddock-api (==2.15.0) [details]
License BSD-3-Clause
Copyright (c) Simon Marlow, David Waern
Author Simon Marlow, David Waern
Maintainer Simon Hengel <sol@typeful.net>, Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
Category Documentation
Home page http://www.haskell.org/haddock/
Bug tracker https://github.com/haskell/haddock/issues
Source repo head: git clone https://github.com/haskell/haddock.git
Uploaded by MateuszKowalczyk at Sun Aug 31 12:06:19 UTC 2014
Distributions Debian:2.13.1, FreeBSD:2.16.1, NixOS:2.20.0
Executables haddock
Downloads 57715 total (301 in the last 30 days)
Rating 2.25 (votes: 2) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Last success reported on 2015-05-30 [all 6 reports]
Hackage Matrix CI

Flags

NameDescriptionDefaultType
in-ghc-tree

Are we in a GHC tree?

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for haddock-2.15.0

[back to package description]
Haddock, a Haskell Documentation Tool
=====================================

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

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.

Haddock understands Haskell's module system, so you can structure your
code however you like without worrying that internal structure will be
exposed in the generated documentation.  For example, it is common to
implement a library in several modules, but define the external API by
having a single module which re-exports parts of these implementation
modules.  Using Haddock, you can still write documentation annotations
next to the actual definitions of the functions and types in the
library, but the documentation annotations from the implementation
will be propagated to the external API when the documentation is
generated.  Abstract types and classes are handled correctly.  In
fact, even without any documentation annotations, Haddock can generate
useful documentation from your source code.

Haddock can generate documentation in multiple formats; currently HTML
is implemented, and there is partial support for generating LaTeX and
Hoogle.

Full documentation can be found in the doc/ subdirectory, in DocBook
format.

Please create issues when you have any problems and pull requests if
you have some code.