Class/Module Index [+]

Quicksearch

YARD::Server::Commands::DisplayObjectCommand

Displays documentation for a specific object identified by the path

Public Instance Methods

index() click to toggle source
# File lib/yard/server/commands/display_object_command.rb, line 29
def index
  Registry.load_all

  options.update(
    :object => '_index.html',
    :objects => Registry.all(:module, :class),
    :type => :layout
  )
  render
end
not_found() click to toggle source
# File lib/yard/server/commands/display_object_command.rb, line 40
def not_found
  super
  self.body = "Could not find object: #{object_path}"
end
run() click to toggle source
# File lib/yard/server/commands/display_object_command.rb, line 8
def run
  if path.empty?
    if options.readme
      url = url_for_file(options.readme)
      self.status, self.headers, self.body = *router.send(:route, url)
      cache(body.first)
      return
    else
      self.path = 'index'
    end
  end
  return index if path == 'index'

  if object = Registry.at(object_path)
    options.update(:type => :layout)
    render(object)
  else
    self.status = 404
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.