module doc_down
import markdown
-import highlight
+import htmlight
private import parser_util
redef class MDoc
var comment: String is lazy do
var lines = content.to_a
if not lines.is_empty then lines.shift
- return content.join("\n").html_escape
+ return lines.join("\n")
end
# Full comment HTML escaped.
- var documentation: String is lazy do return content.join("\n").html_escape
+ var documentation: String is lazy do return content.join("\n")
private var markdown_proc: MarkdownProcessor is lazy, writable do
return original_mentity.as(not null).model.nitdoc_md_processor
var syn = inline_proc.process(content.first)
res.add "<span class=\"synopsys nitdoc\">{syn}</span>"
return res
+ end
+ # Renders the synopsis as a HTML comment block.
+ var md_synopsis: Writable is lazy do
+ if content.is_empty then return ""
+ return content.first
end
# Renders the comment without the synopsis as a HTML comment block.
return lines_to_html(lines)
end
+ #
+ var md_comment: Writable is lazy do
+ if content.is_empty then return ""
+ var lines = content.to_a
+ lines.shift
+ return lines.join("\n")
+ end
+
# Renders the synopsis and the comment as a HTML comment block.
var html_documentation: Writable is lazy do return lines_to_html(content.to_a)
+ # Renders the synopsis and the comment as a HTML comment block.
+ var md_documentation: Writable is lazy do return lines_to_md(content.to_a)
+
# Renders markdown line as a HTML comment block.
private fun lines_to_html(lines: Array[String]): Writable do
var res = new Template
- var decorator = markdown_proc.emitter.decorator.as(NitdocDecorator)
+ var decorator = markdown_proc.decorator.as(NitdocDecorator)
decorator.current_mdoc = self
res.add "<div class=\"nitdoc\">"
# do not use DocUnit as synopsys
not lines.first.has_prefix("\t") then
# parse synopsys
var syn = inline_proc.process(lines.shift)
- res.add "<p class=\"synopsys\">{syn}</p>"
+ res.add "<h1 class=\"synopsys\">{syn}</h1>"
end
end
# check for annotations
res.add "</div>"
decorator.current_mdoc = null
return res
+ end
+ private fun lines_to_md(lines: Array[String]): Writable do
+ var res = new Template
+ if not lines.is_empty then
+ var syn = lines.first
+ if not syn.has_prefix(" ") and not syn.has_prefix("\t") and
+ not syn.trim.has_prefix("#") then
+ lines.shift
+ res.add "# {syn}\n"
+ end
+ end
+ res.add lines.join("\n")
+ return res
end
end
return
end
v.add "<pre class=\"nitcode\"><code>"
- var hl = new HighlightVisitor
+ var hl = new HtmlightVisitor
hl.line_id_prefix = ""
- hl.enter_visit(ast)
+ hl.highlight_node(ast)
v.add(hl.html)
v.add "</code></pre>\n"
end
append_code(v, text, from, to)
else
v.add "<code class=\"nitcode\">"
- var hl = new HighlightVisitor
+ var hl = new HtmlightVisitor
hl.line_id_prefix = ""
- hl.enter_visit(ast)
+ hl.highlight_node(ast)
v.add(hl.html)
end
v.add "</code>"
return
end
v.add "<code class=\"nitcode\">"
- var hl = new HighlightVisitor
- hl.enter_visit(ast)
+ var hl = new HtmlightVisitor
+ hl.highlight_node(ast)
v.add(hl.html)
v.add "</code>"
end
# Get a markdown processor for Nitdoc comments.
var nitdoc_md_processor: MarkdownProcessor is lazy, writable do
var proc = new MarkdownProcessor
- proc.emitter.decorator = new NitdocDecorator
+ proc.decorator = new NitdocDecorator
return proc
end
# This processor is specificaly designed to inlinable doc elements like synopsys.
var nitdoc_inline_processor: MarkdownProcessor is lazy, writable do
var proc = new MarkdownProcessor
- proc.emitter.decorator = new InlineDecorator
+ proc.decorator = new InlineDecorator
return proc
end
end