In Files

Class/Module Index [+]

Quicksearch

YARD

Parts of this source were borrowed from `rdoc/parser/c.rb` RDoc's license is packaged along with Ruby.

Constants

CONFIG_DIR

@deprecated Use {Config::CONFIG_DIR}

ROOT

The root path for YARD source libraries

TEMPLATE_ROOT

The root path for YARD builtin templates

VERSION

Public Class Methods

load_plugins() click to toggle source

(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
parse(*args) click to toggle source

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
parse_string(*args) click to toggle source

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.