1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# frozen_string_literal: true
module YARD
# The root path for YARD source libraries
ROOT = File.expand_path(File.dirname(__FILE__))
require File.join(YARD::ROOT, 'yard', 'version')
require File.join(YARD::ROOT, 'yard', 'autoload')
# The root path for YARD builtin templates
TEMPLATE_ROOT = File.join(ROOT, '..', 'templates')
# @deprecated Use {Config::CONFIG_DIR}
CONFIG_DIR = Config::CONFIG_DIR
# An alias to {Parser::SourceParser}'s parsing method
#
# @example Parse a glob of files
# YARD.parse('lib/**/*.rb')
# @see Parser::SourceParser.parse
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 Parser::SourceParser.parse_string
def self.parse_string(*args) Parser::SourceParser.parse_string(*args) end
# (see YARD::Config.load_plugins)
# @deprecated Use {Config.load_plugins}
def self.load_plugins; YARD::Config.load_plugins end
# @return [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
# @return [Boolean] whether YARD is being run in Ruby 1.8 mode
def self.ruby18?; !ruby19? end
# @return [Boolean] whether YARD is being run in Ruby 1.9 mode
def self.ruby19?; @ruby19 ||= (RUBY_VERSION >= "1.9.1") end
# @return [Boolean] whether YARD is being run in Ruby 2.0
def self.ruby2?; @ruby2 ||= (RUBY_VERSION >= '2.0.0') end
# @return [Boolean] whether YARD is being run in Ruby 3.0
def self.ruby3?; @ruby3 ||= (RUBY_VERSION >= '3.0.0') end
# @return [Boolean] whether YARD is being run in Ruby 3.1
def self.ruby31?; @ruby31 ||= (RUBY_VERSION >= '3.1.0') end
end
# Keep track of Ruby version for compatibility code
# @deprecated Use {YARD.ruby18?} or {YARD.ruby19?} instead.
RUBY18 = YARD.ruby18?
RUBY19 = YARD.ruby19?
# Load Ruby core extension classes
Dir.glob(File.join(YARD::ROOT, 'yard', 'core_ext', '*.rb')).each do |file|
require file
end
# Backport RubyGems SourceIndex and other classes
require File.join(YARD::ROOT, 'yard', 'rubygems', 'backports')
require File.join(YARD::ROOT, 'yard', 'globals')
# Load YARD configuration options (and plugins)
YARD::Config.load
|
