Module CurryDoc.Main

banner :: String   

includeDir :: String   

main :: IO ()   

Further infos:

• might behave indeterministically

processArgs :: DocOptions -> [String] -> IO ()   

Further infos:

• might behave indeterministically

processOpts :: DocOptions -> IO DocOptions   

printUsageMessage :: IO ()   

createDir :: String -> IO ()   

copyDirectory :: String -> String -> IO ()   

Recursively copies a directory structure.

makeCompleteDoc :: DocOptions -> Bool -> String -> String -> IO ()   

The main function of the CurryDoc utility.

Example call:

(makeCompleteDoc docopts recursive docdir modname)

Parameters:

• docopts : the options for CurryDoc
• recursive : True if the documentation for the imported modules should be also generated (if necessary)
• docdir : the directory name containing all documentation files
• modname : the name of the main module to be documented

Further infos:

• might behave indeterministically

makeAbsolute :: String -> IO String   

Transform a file path into an absolute file path:

makeIndexPages :: DocOptions -> String -> [String] -> IO ()   

Generate only the index pages for a list of (already compiled!) modules:

makeSystemLibsIndex :: DocOptions -> String -> [String] -> IO ()   

Generate a system library index page categorizing the given (already compiled!) modules

getModInfo :: String -> IO (Category,String,String)   

prepareDocDir :: DocType -> String -> IO ()   

copyIncludeIfPresent :: String -> String -> IO ()   

readAnaInfo :: String -> IO AnaInfo   

Further infos:

• might behave indeterministically

makeDoc :: DocOptions -> Bool -> String -> String -> IO ()   

Further infos:

• might behave indeterministically

makeDocWithComments :: DocType -> DocOptions -> Bool -> String -> AnaInfo -> String -> String -> [(SourceLine,String)] -> IO ()   

Further infos:

• might behave indeterministically

makeDocIfNecessary :: DocOptions -> Bool -> String -> String -> IO ()   

Generates the documentation for a module if it is necessary. I.e., the documentation is generated if no previous documentation file exists or if the existing documentation file is older than the FlatCurry file.

Further infos:

• might behave indeterministically

getImports :: String -> IO [String]   

copyOrMakeDoc :: DocOptions -> Bool -> String -> String -> IO ()   

Further infos:

• might behave indeterministically

copyDocIfPossible :: DocOptions -> String -> String -> IO Bool   

Copy the documentation file from standard documentation directoy "CDOC" (used for documentation of system libraries) if possible. Returns true if the copy was possible.

readTypesFuncsWithImports :: String -> IO ([TypeDecl],[FuncDecl])   

fileExtension :: DocType -> String   

Further infos:

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

writeOutfile :: DocOptions -> Bool -> String -> String -> IO String -> IO ()   

Further infos:

• might behave indeterministically