|
definition:
|
genHtmlFuncShort :: DocOptions -> [(SourceLine,String)] -> AnaInfo -> CFuncDecl
-> [[BaseHtml]]
genHtmlFuncShort docopts progcmts anainfo
(CFunc (fmod,fname) _ _ ftype _) =
[[code [opnameDoc
[anchored (fname ++ "_SHORT")
[href ('#':fname) [htxt (showId fname)]]],
BaseText (" :: " ++ showQualType docopts fmod ftype)],
nbsp, nbsp]
++ genFuncPropIcons anainfo (fmod,fname) ++
[breakline] ++
removeTopPar
(docComment2HTML docopts
(firstSentence (fst (splitComment
(getFuncComment fname progcmts)))))]
genHtmlFuncShort docopts progcmts anainfo (CmtFunc _ n a vis ftype rules) =
genHtmlFuncShort docopts progcmts anainfo (CFunc n a vis ftype rules)
|
|
demand:
|
argument 4
|
|
deterministic:
|
deterministic operation
|
|
documentation:
|
-- generate short HTML documentation for a function:
|
|
indeterministic:
|
referentially transparent operation
|
|
infix:
|
no fixity defined
|
|
iotype:
|
{(_,_,_,{CFunc}) |-> {:} || (_,_,_,{CmtFunc}) |-> {:}}
|
|
name:
|
genHtmlFuncShort
|
|
precedence:
|
no precedence defined
|
|
result-values:
|
{:}
|
|
signature:
|
CurryDoc.Options.DocOptions -> [(CurryDoc.Read.SourceLine, String)]
-> CurryDoc.AnaInfo.AnaInfo -> AbstractCurry.Types.CFuncDecl
-> [[HTML.Base.BaseHtml]]
|
|
solution-complete:
|
operation might suspend on free variables
|
|
terminating:
|
possibly non-terminating
|
|
totally-defined:
|
possibly non-reducible on same data term
|