| Copyright | Isaac Jones 2003-2005 |
|---|---|
| License | BSD3 |
| Maintainer | cabal-devel@haskell.org |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Distribution.Simple.Haddock
Description
This module deals with the
haddock
and
hscolour
commands.
It uses information about installed packages (from
ghc-pkg
) to find the
locations of documentation for dependent packages, so it can create links.
The
hscolour
support allows generating HTML versions of the original
source, with coloured syntax highlighting.
Synopsis
- haddock :: PackageDescription -> LocalBuildInfo -> [ PPSuffixHandler ] -> HaddockFlags -> IO ()
- hscolour :: PackageDescription -> LocalBuildInfo -> [ PPSuffixHandler ] -> HscolourFlags -> IO ()
- haddockPackagePaths :: [ InstalledPackageInfo ] -> Maybe ( InstalledPackageInfo -> FilePath ) -> NoCallStackIO ([( FilePath , Maybe FilePath , Maybe FilePath )], Maybe String )
Documentation
haddock :: PackageDescription -> LocalBuildInfo -> [ PPSuffixHandler ] -> HaddockFlags -> IO () Source #
hscolour :: PackageDescription -> LocalBuildInfo -> [ PPSuffixHandler ] -> HscolourFlags -> IO () Source #
haddockPackagePaths :: [ InstalledPackageInfo ] -> Maybe ( InstalledPackageInfo -> FilePath ) -> NoCallStackIO ([( FilePath , Maybe FilePath , Maybe FilePath )], Maybe String ) Source #
Given a list of
InstalledPackageInfo
s, return a list of interfaces and
HTML paths, and an optional warning for packages with missing documentation.