<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Distribution.Simple.Haddock</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Distribution-Simple-Haddock.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Cabal-1.14.0: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Maintainer</th><td>cabal-devel@haskell.org</td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Distribution.Simple.Haddock</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module deals with the <code>haddock</code> and <code>hscolour</code> commands. Sadly this is
a rather complicated module. It deals with two versions of haddock (0.x and
2.x). It has to do pre-processing for haddock 0.x which involves
'unlit'ing and using <code>-DHADDOCK</code> for any source code that uses <code>cpp</code>. It
uses information about installed packages (from <code>ghc-pkg</code>) to find the
locations of documentation for dependent packages, so it can create links.
</p><p>The <code>hscolour</code> support allows generating html versions of the original
source, with coloured syntax highlighting.
</p></div></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:haddock" class="def">haddock</a> :: <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a> -> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>] -> <a href="Distribution-Simple-Setup.html#t:HaddockFlags">HaddockFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:hscolour" class="def">hscolour</a> :: <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a> -> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>] -> <a href="Distribution-Simple-Setup.html#t:HscolourFlags">HscolourFlags</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
