module YARD

def self.load_plugins; YARD::Config.load_plugins end

Deprecated:
  • Use {Config.load_plugins}
def self.load_plugins; YARD::Config.load_plugins end

def self.parse(*args) Parser::SourceParser.parse(*args) end

Other tags:
    See: Parser::SourceParser.parse -

Other tags:
    Example: Parse a glob of files - 
def self.parse(*args) Parser::SourceParser.parse(*args) end

def self.parse_string(*args) Parser::SourceParser.parse_string(*args) end

Other tags:
    See: Parser::SourceParser.parse_string -

Other tags:
    Example: Parse a string of input - 
def self.parse_string(*args) Parser::SourceParser.parse_string(*args) end

def self.ruby18?; !ruby19? end

Returns:
  • (Boolean) - whether YARD is being run in Ruby 1.8 mode 
def self.ruby18?; !ruby19? end

def self.ruby19?; @ruby19 ||= (RUBY_VERSION >= "1.9.1") end

Returns:
  • (Boolean) - whether YARD is being run in Ruby 1.9 mode 
def self.ruby19?; @ruby19 ||= (RUBY_VERSION >= "1.9.1") end

def self.ruby2?; @ruby2 ||= (RUBY_VERSION >= '2.0.0') end

Returns:
  • (Boolean) - whether YARD is being run in Ruby 2.0 
def self.ruby2?; @ruby2 ||= (RUBY_VERSION >= '2.0.0') end

def self.ruby31?; @ruby31 ||= (RUBY_VERSION >= '3.1.0') end

Returns:
  • (Boolean) - whether YARD is being run in Ruby 3.1 
def self.ruby31?; @ruby31 ||= (RUBY_VERSION >= '3.1.0') end

def self.ruby3?; @ruby3 ||= (RUBY_VERSION >= '3.0.0') end

Returns:
  • (Boolean) - whether YARD is being run in Ruby 3.0 
def self.ruby3?; @ruby3 ||= (RUBY_VERSION >= '3.0.0') end

def self.windows?

Returns:
  • (Boolean) - whether YARD is being run inside of Windows 
def self.windows?
  return @windows if defined? @windows
  require 'rbconfig'
  @windows =
    ::RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/ ? true : false
ensure
  @windows ||= false
end