X-Git-Url: http://nitlanguage.org diff --git a/src/doc/doc_down.nit b/src/doc/doc_down.nit index e04abb9..dbb5252 100644 --- a/src/doc/doc_down.nit +++ b/src/doc/doc_down.nit @@ -28,18 +28,18 @@ 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 content.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 do - return original_mentity.model.nitdoc_md_processor + private var markdown_proc: MarkdownProcessor is lazy, writable do + return original_mentity.as(not null).model.nitdoc_md_processor end - private var inline_proc: MarkdownProcessor is lazy do - return original_mentity.model.nitdoc_inline_processor + private var inline_proc: MarkdownProcessor is lazy, writable do + return original_mentity.as(not null).model.nitdoc_inline_processor end # Renders the synopsis as a HTML comment block. @@ -64,6 +64,8 @@ redef class MDoc # 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) + decorator.current_mdoc = self res.add "
" # do not use DocUnit as synopsys if not lines.is_empty then @@ -71,7 +73,7 @@ redef class MDoc not lines.first.has_prefix("\t") then # parse synopsys var syn = inline_proc.process(lines.shift) - res.add "

{syn}

" + res.add "

{syn}

" end end # check for annotations @@ -88,15 +90,26 @@ redef class MDoc # add other lines res.add markdown_proc.process(lines.join("\n")) res.add "
" + decorator.current_mdoc = null return res end end -private class NitdocDecorator +# The specific markdown decorator used internally to process MDoc object. +# +# You should use the various methods of `MDoc` like `MDoc::html_documentation` +# +# The class is public so specific behavior can be plugged on it. +class NitdocDecorator super HTMLDecorator - var toolcontext = new ToolContext + private var toolcontext = new ToolContext + + # The currently processed mdoc. + # + # Unfortunately, this seems to be the simpler way to get the currently processed `MDoc` object. + var current_mdoc: nullable MDoc = null redef fun add_code(v, block) do var meta = block.meta or else "nit" @@ -143,7 +156,7 @@ private class NitdocDecorator v.add "" end - fun code_from_text(buffer: Text, from, to: Int): String do + private fun code_from_text(buffer: Text, from, to: Int): String do var out = new FlatBuffer for i in [from..to[ do out.add buffer[i] return out.write_to_string @@ -184,7 +197,7 @@ end redef class Model # Get a markdown processor for Nitdoc comments. - var nitdoc_md_processor: MarkdownProcessor is lazy do + var nitdoc_md_processor: MarkdownProcessor is lazy, writable do var proc = new MarkdownProcessor proc.emitter.decorator = new NitdocDecorator return proc @@ -193,7 +206,7 @@ redef class Model # Get a markdown inline processor for Nitdoc comments. # # This processor is specificaly designed to inlinable doc elements like synopsys. - var nitdoc_inline_processor: MarkdownProcessor is lazy do + var nitdoc_inline_processor: MarkdownProcessor is lazy, writable do var proc = new MarkdownProcessor proc.emitter.decorator = new InlineDecorator return proc