Skip to content

Crystal

DocRenderer

class `Crystal::Doc::Markdown::DocRenderer`
inherits `Crystal::Doc::Markdown::HTMLRenderer` ¶

Class methods¶

`.new(obj : Constant | Macro | Method, io)` ¶

`.new(type : Crystal::Doc::Type, io)` ¶

Methods¶

`#begin_code(language = nil)` ¶

`#begin_inline_code` ¶

For inline code we search if there's a method with that name in the current type (it's usual to refer to these as method).

If there is a match, we output the link without the <code>...</code> tag (looks better). If there isn't a match, we want to preserve the code tag.

`#begin_link(url)` ¶

`#end_code` ¶

`#end_inline_code` ¶

`#end_link` ¶

`#expand_code_links(text : String) : String` ¶

`#lookup_method(type, name, args, kind = nil)` ¶

`#method_link(method, text)` ¶

`#text(text)` ¶

`#type_link(type, text)` ¶