|
definition:
|
makeDocIfNecessary :: DocOptions -> Bool -> String -> String -> IO ()
makeDocIfNecessary docopts recursive docdir modname =
when (modname `notElem` docMods docopts) $ do
let docfile = docdir </> modname ++
(if docType docopts == HtmlDoc then ".html" else ".tex")
docexists <- doesFileExist docfile
if not docexists
then copyOrMakeDoc docopts recursive docdir modname
else do
ctime <- getFlatCurryFileInLoadPath modname >>= getModificationTime
dftime <- getModificationTime docfile
if compareClockTime ctime dftime == GT
then copyOrMakeDoc docopts recursive docdir modname
else when recursive $ do
imports <- getImports modname
mapM_ (makeDocIfNecessary docopts recursive docdir) imports
|
|
demand:
|
no demanded arguments
|
|
deterministic:
|
deterministic operation
|
|
documentation:
|
--- 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.
|
|
indeterministic:
|
might be indeterministic
|
|
infix:
|
no fixity defined
|
|
iotype:
|
{(_,_,_,_) |-> _}
|
|
name:
|
makeDocIfNecessary
|
|
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
|