Module CurryDoc.Options

Summary of exported operations:

defaultCurryDocOptions :: DocOptions  Deterministic 
Default options

Exported datatypes:


DocType

The kind of documentations which can be generated.

Constructors:

  • HtmlDoc :: DocType
  • TexDoc :: DocType
  • CDoc :: DocType

DocOptions

The options for the documentation generator. docType - the target format of the documentation withIndex - True if the index pages should also be generated withMarkdown - True if the comments should be processed as markdown code mainTitle - the main title of the docmentation useDirURL - "--use" options (i.e., source dir and corresponding doc URL) docMods - the list of already documented modules, i.e., where the documentation does not need generated docURL - the mapping from module names into the URL of their docs

Constructors:

  • DocOptions :: DocType -> Bool -> Bool -> String -> [(String,String)] -> [String] -> (String -> String) -> DocOptions

    Fields:

    • docType :: DocType
    • withIndex :: Bool
    • withMarkdown :: Bool
    • mainTitle :: String
    • useDirURL :: [(String,String)]
    • docMods :: [String]
    • docURL :: (String -> String)

Exported operations:

defaultCurryDocOptions :: DocOptions  Deterministic 

Default options

Further infos:
  • solution complete, i.e., able to compute all solutions