Module CurryDoc.CDoc

Functions to generate documentation in "CDoc" format.

Author: Sandra Dylus

Version: November 2015

Summary of exported operations:

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

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

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

flexRigid
                  ::  Rule -> FlexRigidResult

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

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

ModuleInfo

Constructors:

CurryInfo

Constructors:

FunctionInfo

Constructors:

FunctionInfo :: String -> TypeExpr -> String -> String -> Bool -> FlexRigidResult -> FunctionInfo

TypeInfo

Constructors:

TypeInfo :: String -> [(QName,[TypeExpr])] -> [TVarIndex] -> String -> String -> Bool -> TypeInfo

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])

Further infos: