Life as a maintainer after the xz utils backdoor hack 👉 Watch now!

haddock-api
Release 2.29.1

Haskell Documentation Tool

Keywords: documentation, library, Propose Tags, , Last Documentation, haddock-api-2.29.1.tar.gz, browse, Package description, Package maintainers, BenGamari, HerbertValerioRiedel, MateuszKowalczyk, alexbiehl, Helkafen, harpocrates, hecate, edit package information , 2.18.1, 2.19.0, 2.19.0.1, 2.20.0, 2.21.0, 2.22.0, 2.23.0, 2.23.1, 2.24.0, 2.24.1, 2.24.2, 2.25.0, 2.25.1, 2.26.0, 2.27.0, 2.29.0, 2.29.1, haskell
License: BSD-2-Clause
Install: cabal install haddock-api-2.29.1

Documentation

Haddock

Haddock is the standard tool for generating documentation from Haskell code. Full documentation about Haddock itself can be found in the doc/ subdirectory, in reStructuredText format.

Project overview

This project consists of three packages:

haddock: provides the haddock executable. It is implemented as a tiny wrapper around haddock-api's Documentation.Haddock.haddock function.
haddock-api: contains the program logic of the haddock tool. The haddocks for the Documentation.Haddock module offer a good overview of the functionality.
haddock-library: is concerned with the parsing and processing of the Haddock markup language. Unlike the other packages, it is expected to build on a fairly wide range of GHC versions.