/
yard.rb
48 lines (37 loc) · 1.47 KB
/
yard.rb
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
require File.expand_path('../yard/version.rb', __FILE__)
module YARD
# The root path for YARD source libraries
ROOT = File.expand_path(File.dirname(__FILE__))
# The root path for YARD builtin templates
TEMPLATE_ROOT = File.join(ROOT, '..', 'templates')
# @deprecated Use {Config::CONFIG_DIR}
CONFIG_DIR = File.expand_path('~/.yard')
# 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
end
# Keep track of Ruby version for compatibility code
RUBY19, RUBY18 = *(RUBY_VERSION >= "1.9.1" ? [true, false] : [false, true])
# 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')
['autoload', 'globals'].each do |file|
require File.join(YARD::ROOT, 'yard', file)
end
# Load YARD configuration options (and plugins)
YARD::Config.load