haddock

Portability | portable
Stability | experimental
Maintainer | haddock@projects.haskell.org
Safe Haskell | Safe-Infered

Haddock.Options

Description

Definition of the command line interface of Haddock.

# Documentation

parseHaddockOpts :: [String] -> IO ([Flag], [String])

data Flag

Constructors

Flag_BuiltInThemes |
Flag_CSS String |
Flag_ReadInterface String |
Flag_DumpInterface String |
Flag_Heading String |
Flag_Html |
Flag_Hoogle |
Flag_Lib String |
Flag_OutputDir FilePath |
Flag_Prologue FilePath |
Flag_SourceBaseURL String |
Flag_SourceModuleURL String |
Flag_SourceEntityURL String |
Flag_WikiBaseURL String |
Flag_WikiModuleURL String |
Flag_WikiEntityURL String |
Flag_LaTeX |
Flag_LaTeXStyle String |
Flag_Help |
Flag_Verbosity String |
Flag_Version |
Flag_InterfaceVersion |
Flag_UseContents String |
Flag_GenContents |
Flag_UseIndex String |
Flag_GenIndex |
Flag_IgnoreAllExports |
Flag_HideModule String |
Flag_OptGhc String |
Flag_GhcLibDir String |
Flag_GhcVersion |
Flag_PrintGhcPath |
Flag_PrintGhcLibDir |
Flag_NoWarnings |
Flag_UseUnicode |
Flag_NoTmpCompDir |
Flag_Qualification String |
Flag_PrettyHtml |

Instances

Eq Flag |

getUsage :: IO String

optTitle :: [Flag] -> Maybe String

outputDir :: [Flag] -> FilePath

optContentsUrl :: [Flag] -> Maybe String

optIndexUrl :: [Flag] -> Maybe String

optCssFile :: [Flag] -> Maybe FilePath

sourceUrls :: [Flag] -> (Maybe String, Maybe String, Maybe String)

wikiUrls :: [Flag] -> (Maybe String, Maybe String, Maybe String)

optDumpInterfaceFile :: [Flag] -> Maybe FilePath

optLaTeXStyle :: [Flag] -> Maybe String

qualification :: [Flag] -> Qualification

verbosity :: [Flag] -> Verbosity

ghcFlags :: [Flag] -> [String]

readIfaceArgs :: [Flag] -> [(DocPaths, FilePath)]