CurryInfo: currydoc-4.0.0 / CurryDoc.Html.genConsIndexPage
definition: 
|
genConsIndexPage :: (String,[BaseHtml]) -> DocOptions -> String
-> [FC.TypeDecl] -> IO ()
genConsIndexPage homeref opts docdir types = do
putStrLn $ "Writing constructor index page to '"++ docdir ++"/cindex.html'..."
simplePage homeref "Index to all constructors" Nothing allConsFuncsMenu
(htmlConsIndex opts (sortNames expcons))
>>= writeFile (docdir </> "cindex.html")
where
consDecls (FC.Type _ _ _ cs) = cs
consDecls (FC.TypeSyn _ _ _ _ ) = []
consDecls (FC.TypeNew _ _ _ (FC.NewCons cn cv ct)) = [FC.Cons cn 1 cv [ct]]
expcons = map FCG.consName $ filter ((== FC.Public) . FCG.consVisibility) $
concatMap consDecls types
|
|
demand:
|
no demanded arguments |
|
deterministic:
|
deterministic operation |
|
documentation:
|
----------------------------------------------------------------------- generate the constructor index page for the documentation directory: |
|
indeterministic:
|
referentially transparent operation |
|
infix:
|
no fixity defined |
|
iotype:
|
{(_,_,_,_) |-> _}
|
|
name:
|
genConsIndexPage |
|
precedence:
|
no precedence defined |
|
result-values:
|
_ |
|
signature:
|
(String, [HTML.Base.BaseHtml]) -> CurryDoc.Options.DocOptions -> String -> [FlatCurry.Types.TypeDecl] -> Prelude.IO () |
|
solution-complete:
|
operation might suspend on free variables |
|
terminating:
|
possibly non-terminating |
|
totally-defined:
|
possibly non-reducible on same data term |