Method: YARD::Templates::Helpers::HtmlHelper#html_markup_rdoc

Defined in:
lib/yard/templates/helpers/html_helper.rb

#html_markup_rdoc(text) ⇒ String

Converts RDoc formatting (SimpleMarkup) to HTML

Parameters:

  • text (String) —

    the input RDoc formatted text

Returns:

Since:

  • 0.6.0

[View source]

91
92
93
94
95
 
# File 'lib/yard/templates/helpers/html_helper.rb', line 91

def html_markup_rdoc(text)
  doc = markup_class(:rdoc).new(text)
  doc.from_path = url_for(object) if doc.respond_to?(:from_path=)
  doc.to_html
end