@deprecated Use {Config::CONFIG_DIR}
The root path for YARD source libraries
The root path for YARD builtin templates
(see YARD::Config.load_plugins) @deprecated Use {Config.load_plugins}
# File lib/yard.rb, line 29 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 Parser::SourceParser.parse
# File lib/yard.rb, line 18 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
# File lib/yard.rb, line 25 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 45 def self.ruby18?; !ruby19? end
@return [Boolean] whether YARD is being run in Ruby 1.9 mode
# File lib/yard.rb, line 48 def self.ruby19?; @ruby19 ||= (RUBY_VERSION >= "1.9.1") end
@return [Boolean] whether YARD is being run inside of Windows
# File lib/yard.rb, line 32 def self.windows? return @windows if defined? @windows require 'rbconfig' if ::RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/ @wnidows = true else @windows = false end ensure @windows ||= false end
Generated with the Darkfish Rdoc Generator 2.