<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ --> <title>src/Documentation/Haddock.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-2"></a><span class='hs-comment'>-- |</span> <a name="line-3"></a><span class='hs-comment'>-- Module : Documentation.Haddock</span> <a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) David Waern 2010</span> <a name="line-5"></a><span class='hs-comment'>-- License : BSD-like</span> <a name="line-6"></a><span class='hs-comment'>--</span> <a name="line-7"></a><span class='hs-comment'>-- Maintainer : haddock@projects.haskellorg</span> <a name="line-8"></a><span class='hs-comment'>-- Stability : experimental</span> <a name="line-9"></a><span class='hs-comment'>-- Portability : portable</span> <a name="line-10"></a><span class='hs-comment'>--</span> <a name="line-11"></a><span class='hs-comment'>-- The Haddock API: A rudimentory, highly experimental API exposing some of</span> <a name="line-12"></a><span class='hs-comment'>-- the internals of Haddock. Don't expect it to be stable.</span> <a name="line-13"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-14"></a> <a name="line-15"></a> <a name="line-16"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Documentation</span><span class='hs-varop'>.</span><span class='hs-conid'>Haddock</span> <span class='hs-layout'>(</span> <a name="line-17"></a> <a name="line-18"></a> <span class='hs-comment'>-- * Interface</span> <a name="line-19"></a> <span class='hs-conid'>Interface</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-20"></a> <span class='hs-conid'>InstalledInterface</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-21"></a> <span class='hs-varid'>createInterfaces</span><span class='hs-layout'>,</span> <a name="line-22"></a> <a name="line-23"></a> <span class='hs-comment'>-- * Export items & declarations</span> <a name="line-24"></a> <span class='hs-conid'>ExportItem</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-25"></a> <span class='hs-conid'>DeclInfo</span><span class='hs-layout'>,</span> <a name="line-26"></a> <span class='hs-conid'>DocForDecl</span><span class='hs-layout'>,</span> <a name="line-27"></a> <span class='hs-conid'>FnArgsDoc</span><span class='hs-layout'>,</span> <a name="line-28"></a> <a name="line-29"></a> <span class='hs-comment'>-- * Hyperlinking</span> <a name="line-30"></a> <span class='hs-conid'>LinkEnv</span><span class='hs-layout'>,</span> <a name="line-31"></a> <span class='hs-conid'>DocName</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-32"></a> <span class='hs-varid'>docNameOcc</span><span class='hs-layout'>,</span> <a name="line-33"></a> <a name="line-34"></a> <span class='hs-comment'>-- * Instances</span> <a name="line-35"></a> <span class='hs-conid'>DocInstance</span><span class='hs-layout'>,</span> <a name="line-36"></a> <span class='hs-conid'>InstHead</span><span class='hs-layout'>,</span> <a name="line-37"></a> <a name="line-38"></a> <span class='hs-comment'>-- * Documentation comments</span> <a name="line-39"></a> <span class='hs-conid'>Doc</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-40"></a> <span class='hs-conid'>DocMarkup</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-41"></a> <span class='hs-conid'>HaddockModInfo</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-42"></a> <a name="line-43"></a> <span class='hs-comment'>-- * Interface files</span> <a name="line-44"></a> <span class='hs-comment'>-- | (.haddock files)</span> <a name="line-45"></a> <span class='hs-conid'>InterfaceFile</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-46"></a> <span class='hs-varid'>readInterfaceFile</span><span class='hs-layout'>,</span> <a name="line-47"></a> <span class='hs-varid'>nameCacheFromGhc</span><span class='hs-layout'>,</span> <a name="line-48"></a> <span class='hs-varid'>freshNameCache</span><span class='hs-layout'>,</span> <a name="line-49"></a> <span class='hs-conid'>NameCacheAccessor</span><span class='hs-layout'>,</span> <a name="line-50"></a> <a name="line-51"></a> <span class='hs-comment'>-- * Flags and options</span> <a name="line-52"></a> <span class='hs-conid'>Flag</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-53"></a> <span class='hs-conid'>DocOption</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <a name="line-54"></a> <a name="line-55"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-56"></a> <a name="line-57"></a> <a name="line-58"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>InterfaceFile</span> <a name="line-59"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Interface</span> <a name="line-60"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <a name="line-61"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Options</span> </pre></body> </html>