Module CurryDoc.CDoc

Functions to generate documentation in "CDoc" format.

Author: Sandra Dylus

Version: November 2020

Summary of exported operations:

generateCDoc :: String -> String -> [(SourceLine,String)] -> AnaInfo -> IO String   
removeForall :: TypeExpr -> TypeExpr   
funcComment :: String -> [(SourceLine,String)] -> String   
dataComment :: String -> [(SourceLine,String)] -> String   
flexRigid :: Rule -> FlexRigidResult   
author :: [(String,String)] -> String   
consSignature :: ConsDecl -> ((String,String),[TypeExpr])   

Exported datatypes:


ModuleInfo

Constructors:

  • ModuleInfo :: String -> String -> String -> ModuleInfo

CurryInfo

Constructors:


FunctionInfo

Constructors:


TypeInfo

Constructors:


Exported operations:

generateCDoc :: String -> String -> [(SourceLine,String)] -> AnaInfo -> IO String   

funcComment :: String -> [(SourceLine,String)] -> String   

dataComment :: String -> [(SourceLine,String)] -> String   

author :: [(String,String)] -> String   

consSignature :: ConsDecl -> ((String,String),[TypeExpr])