Method: YARD::Server::Commands::Base#render

Defined in:

lib/yard/server/commands/base.rb

#render(object = nil) ⇒ String (protected)

TODO:

This method is dependent on #options, it should be in LibraryCommand.

Renders a specific object if provided, or a regular template rendering if object is not provided.

Parameters:

• object (CodeObjects::Base, nil) (defaults to: nil) —

  calls CodeObjects::Base#format if an object is provided, or Templates::Engine.render if object is nil. Both receive #options as an argument.

Returns:

• (String) —

  the resulting output to display

Since:

• 0.6.0

# File 'lib/yard/server/commands/base.rb', line 138

def render(object = nil)
  case object
  when CodeObjects::Base
    cache object.format(options)
  when nil
    cache Templates::Engine.render(options)
  else
    cache object
  end
end