Method: YARD::Templates::Engine.generate

Defined in:

lib/yard/templates/engine.rb

.generate(objects, options = {}) ⇒ void

This method returns an undefined value.

Passes a set of objects to the :fulldoc template for full documentation generation. This is called by CLI::Yardoc to most commonly perform HTML documentation generation.

Parameters:

• objects (Array<CodeObjects::Base>) —

  a list of CodeObjects::Base objects to pass to the template

• options (Hash) (defaults to: {}) —

  (see render)

# File 'lib/yard/templates/engine.rb', line 101

def generate(objects, options = {})
  options = set_default_options(options)
  options.objects = objects
  options.object = Registry.root
  template(options.template, :fulldoc, options.format).run(options)
end