module YARD
Backward compatibility for gem specification lookup @see Gem::SourceIndex
Gem::YARDoc provides methods to generate YARDoc and yri data for installed gems upon gem installation.
This file is automatically required by RubyGems 1.9 and newer.
Constants
Public Class Methods
(see YARD::Config.load_plugins) @deprecated Use {Config.load_plugins}
# File lib/yard.rb, line 30 def self.load_plugins; YARD::Config.load_plugins end
An alias to {Parser::SourceParser}'s parsing method
@example Parse a glob of files
YARD.parse('lib /*.rb')
@see YARD::Parser::SourceParser.parse
# File lib/yard.rb, line 19 def self.parse(*args) Parser::SourceParser.parse(*args) end
An alias to {Parser::SourceParser}'s parsing method
@example Parse a string of input
YARD.parse_string('class Foo; end')
@see YARD::Parser::SourceParser.parse_string
# File lib/yard.rb, line 26 def self.parse_string(*args) Parser::SourceParser.parse_string(*args) end
@return [Boolean] whether YARD is being run in Ruby 1.8 mode
# File lib/yard.rb, line 43 def self.ruby18?; !ruby19? end
@return [Boolean] whether YARD is being run in Ruby 1.9 mode
# File lib/yard.rb, line 46 def self.ruby19?; @ruby19 ||= (RUBY_VERSION >= "1.9.1") end
@return [Boolean] whether YARD is being run in Ruby 2.0
# File lib/yard.rb, line 49 def self.ruby2?; @ruby2 ||= (RUBY_VERSION >= '2.0.0') end
@return [Boolean] whether YARD is being run inside of Windows
# File lib/yard.rb, line 33 def self.windows? return @windows if defined? @windows require 'rbconfig' @windows = ::RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/ ? true : false ensure @windows ||= false end