CurryInfo: currydoc-4.0.0 / CurryDoc.Html.docComment2HTML
definition: 
|
docComment2HTML :: DocOptions -> String -> [BaseHtml] docComment2HTML opts cmt | null cmt = [] | withMarkdown opts = markdownText2HTML (replaceIdLinks opts cmt) | otherwise = [par [BaseText (replaceIdLinks opts cmt)]] |
|
demand:
|
argument 2 |
|
deterministic:
|
deterministic operation |
|
documentation:
|
Translate a documentation comment to HTML and use markdown translation if necessary @return: either a paragraph (`<p>`) element or an empty list. |
|
indeterministic:
|
referentially transparent operation |
|
infix:
|
no fixity defined |
|
iotype:
|
{(_,_) |-> _}
|
|
name:
|
docComment2HTML |
|
precedence:
|
no precedence defined |
|
result-values:
|
_ |
|
signature:
|
CurryDoc.Options.DocOptions -> String -> [HTML.Base.BaseHtml] |
|
solution-complete:
|
operation might suspend on free variables |
|
terminating:
|
possibly non-terminating |
|
totally-defined:
|
possibly non-reducible on same data term |