Module CurryDoc.TeX

Functions to generate documentation in TeX format.

Author: Michael Hanus

Version: March 2021

Summary of exported operations:

generateTexDocs :: DocOptions -> AnaInfo -> String -> String -> [(SourceLine,String)] -> IO String  Non-deterministic 
htmlString2Tex :: DocOptions -> String -> String  Deterministic 
Translate a documentation comment to LaTeX and use markdown translation if necessary.
replaceIdLinks :: String -> String  Deterministic 
genTexFunc :: DocOptions -> [(SourceLine,String)] -> a -> FuncDecl -> String  Deterministic 
genTexType :: DocOptions -> [(SourceLine,String)] -> TypeDecl -> String  Deterministic 
generate TeX documentation for a datatype if it is exported and not a dictionary:
genHtmlCons :: DocOptions -> [String] -> String -> [(Int,a)] -> ConsDecl -> String  Deterministic 
showTexType :: Bool -> TypeExpr -> String  Deterministic 
string2tex :: String -> String  Deterministic 

Exported operations:

generateTexDocs :: DocOptions -> AnaInfo -> String -> String -> [(SourceLine,String)] -> IO String  Non-deterministic 

htmlString2Tex :: DocOptions -> String -> String  Deterministic 

Translate a documentation comment to LaTeX and use markdown translation if necessary. If the string contains HTML tags, these are also translated into LaTeX.

genTexFunc :: DocOptions -> [(SourceLine,String)] -> a -> FuncDecl -> String  Deterministic 

genTexType :: DocOptions -> [(SourceLine,String)] -> TypeDecl -> String  Deterministic 

generate TeX documentation for a datatype if it is exported and not a dictionary:

Further infos:
  • partially defined

genHtmlCons :: DocOptions -> [String] -> String -> [(Int,a)] -> ConsDecl -> String  Deterministic 

showTexType :: Bool -> TypeExpr -> String  Deterministic 

Further infos:
  • partially defined

string2tex :: String -> String  Deterministic