<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--Rendered using the Haskell Html Library v0.2--> <HTML ><HEAD ><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" ><TITLE >HaddockUtils</TITLE ><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css" ><SCRIPT SRC="haddock-util.js" TYPE="text/javascript" ></SCRIPT ><SCRIPT TYPE="text/javascript" >window.onload = function () {setSynopsis("mini_HaddockUtils.html")};</SCRIPT ></HEAD ><BODY ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="topbar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" " ></TD ><TD CLASS="title" >ghc-6.10.4: The GHC API</TD ><TD CLASS="topbut" ><A HREF="index.html" >Contents</A ></TD ><TD CLASS="topbut" ><A HREF="doc-index.html" >Index</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="modulebar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><FONT SIZE="6" >HaddockUtils</FONT ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Synopsis</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="#v%3AparseModuleHeader" >parseModuleHeader</A > :: <A HREF="../base/Data-Char.html#t%3AString" >String</A > -> <A HREF="../base/Data-Either.html#t%3AEither" >Either</A > <A HREF="../base/Data-Char.html#t%3AString" >String</A > (<A HREF="../base/Data-Char.html#t%3AString" >String</A >, <A HREF="HsSyn.html#t%3AHaddockModInfo" >HaddockModInfo</A > <A HREF="RdrName.html#t%3ARdrName" >RdrName</A >)</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AparseKey" >parseKey</A > :: <A HREF="../base/Data-Char.html#t%3AString" >String</A > -> <A HREF="../base/Data-Char.html#t%3AString" >String</A > -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="../base/Data-Char.html#t%3AString" >String</A >, <A HREF="../base/Data-Char.html#t%3AString" >String</A >)</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >type</SPAN > <A HREF="#t%3AField" >Field</A > a = ([<A HREF="SrcLoc.html#t%3ALocated" >Located</A > a], <A HREF="HsTypes.html#t%3ALBangType" >LBangType</A > a, <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a))</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AaddFieldDoc" >addFieldDoc</A > :: <A HREF="HaddockUtils.html#t%3AField" >Field</A > a -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> <A HREF="HaddockUtils.html#t%3AField" >Field</A > a</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AaddFieldDocs" >addFieldDocs</A > :: [<A HREF="HaddockUtils.html#t%3AField" >Field</A > a] -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> [<A HREF="HaddockUtils.html#t%3AField" >Field</A > a]</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AaddConDoc" >addConDoc</A > :: <A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> <A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AaddConDocs" >addConDocs</A > :: [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a] -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a]</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AaddConDocFirst" >addConDocFirst</A > :: [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a] -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a]</TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Documentation</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:parseModuleHeader" ><A NAME="v%3AparseModuleHeader" ></A ></A ><B >parseModuleHeader</B > :: <A HREF="../base/Data-Char.html#t%3AString" >String</A > -> <A HREF="../base/Data-Either.html#t%3AEither" >Either</A > <A HREF="../base/Data-Char.html#t%3AString" >String</A > (<A HREF="../base/Data-Char.html#t%3AString" >String</A >, <A HREF="HsSyn.html#t%3AHaddockModInfo" >HaddockModInfo</A > <A HREF="RdrName.html#t%3ARdrName" >RdrName</A >)</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:parseKey" ><A NAME="v%3AparseKey" ></A ></A ><B >parseKey</B > :: <A HREF="../base/Data-Char.html#t%3AString" >String</A > -> <A HREF="../base/Data-Char.html#t%3AString" >String</A > -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="../base/Data-Char.html#t%3AString" >String</A >, <A HREF="../base/Data-Char.html#t%3AString" >String</A >)</TD ></TR ><TR ><TD CLASS="doc" ><P >This function is how we read keys. </P ><P >all fields in the header are optional and have the form </P ><DL ><DT >spaces1</DT ><DD >[field name][spaces] <A HREF=":.html" >:</A > [text]<A HREF="n.html" >n</A > ([spaces2][space][text]<A HREF="n.html" >n</A > | [spaces]<A HREF="n.html" >n</A >)* where each [spaces2] should have [spaces1] as a prefix. </DD ></DL ><P >Thus for the key <A HREF="Description.html" >Description</A >, </P ><PRE > Description : this is a rather long description The module comment starts here </PRE ><P >the value will be <A HREF="this is a -- description.html" >this is a .. description</A > and the rest will begin at <A HREF="The module comment.html" >The module comment</A >. </P ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >type</SPAN > <A NAME="t:Field" ><A NAME="t%3AField" ></A ></A ><B >Field</B > a = ([<A HREF="SrcLoc.html#t%3ALocated" >Located</A > a], <A HREF="HsTypes.html#t%3ALBangType" >LBangType</A > a, <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a))</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:addFieldDoc" ><A NAME="v%3AaddFieldDoc" ></A ></A ><B >addFieldDoc</B > :: <A HREF="HaddockUtils.html#t%3AField" >Field</A > a -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> <A HREF="HaddockUtils.html#t%3AField" >Field</A > a</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:addFieldDocs" ><A NAME="v%3AaddFieldDocs" ></A ></A ><B >addFieldDocs</B > :: [<A HREF="HaddockUtils.html#t%3AField" >Field</A > a] -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> [<A HREF="HaddockUtils.html#t%3AField" >Field</A > a]</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:addConDoc" ><A NAME="v%3AaddConDoc" ></A ></A ><B >addConDoc</B > :: <A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> <A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:addConDocs" ><A NAME="v%3AaddConDocs" ></A ></A ><B >addConDocs</B > :: [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a] -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a]</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:addConDocFirst" ><A NAME="v%3AaddConDocFirst" ></A ></A ><B >addConDocFirst</B > :: [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a] -> <A HREF="../base/Data-Maybe.html#t%3AMaybe" >Maybe</A > (<A HREF="HsDoc.html#t%3ALHsDoc" >LHsDoc</A > a) -> [<A HREF="HsDecls.html#t%3ALConDecl" >LConDecl</A > a]</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="botbar" >Produced by <A HREF="http://www.haskell.org/haddock/" >Haddock</A > version 2.4.2</TD ></TR ></TABLE ></BODY ></HTML >