| definition: |
makeCompleteDoc :: DocOptions -> Bool -> String -> String -> IO ()
makeCompleteDoc docopts recursive reldocdir modpath = do
docdir <- makeAbsolute reldocdir
prepareDocDir (docType docopts) docdir
lookupModuleSourceInLoadPath modpath >>=
maybe (error $ "Source code of module '" ++ modpath ++ "' not found!")
(\ (moddir,_) -> do
let modname = takeFileName modpath
homeref = ("index.html", [htxt "Program", nbsp, code [htxt modname]])
setCurrentDirectory moddir
-- parsing source program:
callFrontend FCY modname
-- generate abstract curry representation
callFrontend ACY modname
-- when constructing CDOC the imported modules don't have to be read
-- from the FlatCurry file
(alltypes,allfuns) <- getProg modname $ docType docopts
makeDocIfNecessary docopts recursive docdir modname
when (withIndex docopts) $ do
genMainIndexPage docopts docdir [modname]
genFunctionIndexPage homeref docopts docdir allfuns
genConsIndexPage homeref docopts docdir alltypes
-- change access rights to readable for everybody:
system ("chmod -R go+rX "++docdir)
putStrLn ("Documentation files written into directory "++docdir) )
where
getProg modname HtmlDoc = readTypesFuncsWithImports modname
getProg modname TexDoc = readTypesFuncsWithImports modname
getProg modname CDoc = do (Prog _ _ types funs _) <- readFlatCurry modname
return (types,funs)
|
| demand: |
no demanded arguments |
| deterministic: |
deterministic operation |
| documentation: |
-------------------------------------------------------------------------- --- The main function of the CurryDoc utility. --- @param docopts - the options for CurryDoc --- @param recursive - True if the documentation for the imported modules --- should be also generated (if necessary) --- @param docdir - the directory name containing all documentation files --- @param modname - the name of the main module to be documented |
| indeterministic: |
might be indeterministic |
| infix: |
no fixity defined |
| iotype: |
{(_,_,_,_) |-> _}
|
| name: |
makeCompleteDoc |
| precedence: |
no precedence defined |
| result-values: |
_ |
| signature: |
CurryDoc.Options.DocOptions -> Prelude.Bool -> String -> String -> Prelude.IO () |
| solution-complete: |
operation might suspend on free variables |
| terminating: |
possibly non-terminating |
| totally-defined: |
possibly non-reducible on same data term |