Class: Nanoc::Filters::RDoc Private

Inherits:
Nanoc::Filter
  • Object
show all
Defined in:
lib/nanoc/filters/rdoc.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Instance Method Summary collapse

Instance Method Details

#run(content, _params = {}) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Runs the content through [RDoc::Markup](docs.seattlerb.org/rdoc/RDoc/Markup.html). This method takes no options.

Parameters:

  • content (String) —

    The content to filter

Returns:

  • (String) —

    The filtered content



16
17
18
19
20
 
# File 'lib/nanoc/filters/rdoc.rb', line 16

def run(content, _params = {})
  options = ::RDoc::Options.new
  to_html = ::RDoc::Markup::ToHtml.new(options)
  ::RDoc::Markup.new.convert(content, to_html)
end