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 [LibraryOptions] 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 51
def initialize(opts = {})
  super
  self.serializer = DocServerSerializer.new
end

Public Instance Methods

call(request) click to toggle source
# File lib/yard/server/commands/library_command.rb, line 56
def call(request)
  save_default_template_info
  self.request = request
  self.options = LibraryOptions.new
  self.options.reset_defaults
  self.options.command = self
  setup_library
  self.options.title = "Documentation for #{library.name} " +
    (library.version ? '(' + library.version + ')' : '')
  super
rescue LibraryNotPreparedError
  not_prepared
ensure
  restore_template_info
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.