Parent

Methods

Class/Module Index [+]

Quicksearch

YARD::Server::Commands::LibraryCommand

This is the base command for all commands that deal directly with libraries. Some commands do not, but most (like {DisplayObjectCommand}) do. If your command deals with libraries directly, subclass this class instead. See {Base} for notes on how to subclass a command.

@abstract

Attributes

incremental[RW]

@return [Boolean] whether to reparse data

library[RW]

@return [LibraryVersion] the object containing library information

options[RW]

@return [Hash{Symbol => Object}] default options for the library

serializer[RW]

@return [Serializers::Base] the serializer used to perform file linking

single_library[RW]

@return [Boolean] whether router should route for multiple libraries

Public Class Methods

new(opts = {}) click to toggle source
# File lib/yard/server/commands/library_command.rb, line 32
def initialize(opts = {})
  super
  self.serializer = DocServerSerializer.new(self)
end

Public Instance Methods

call(request) click to toggle source
# File lib/yard/server/commands/library_command.rb, line 37
def call(request)
  self.request = request
  self.options = SymbolHash.new(false).update(
    :serialize => false,
    :serializer => serializer,
    :library => library,
    :adapter => adapter,
    :single_library => single_library,
    :markup => :rdoc,
    :format => :html
  )
  setup_library
  super
rescue LibraryNotPreparedError
  not_prepared
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.