Method: YARD::Server::LibraryVersion#initialize

Defined in:
lib/yard/server/library_version.rb

#initialize(name, version = nil, yardoc = nil, source = :disk) ⇒ LibraryVersion

Returns a new instance of LibraryVersion.

Parameters:

  • name (String) —

    the name of the library

  • version (String) (defaults to: nil) —

    the specific (usually, but not always, numeric) library version

  • yardoc (String) (defaults to: nil) —

    the location of the yardoc file, or nil if it is generated later

  • source (Symbol) (defaults to: :disk) —

    the location of the files used to build the yardoc. Builtin source types are :disk or :gem.

Since:

  • 0.6.0



134
135
136
137
138
139
 
# File 'lib/yard/server/library_version.rb', line 134

def initialize(name, version = nil, yardoc = nil, source = :disk)
  self.name = name
  self.yardoc_file = yardoc
  self.version = version
  self.source = source
end