Module: YARD::APIPlugin

Defined in:
lib/yard-api.rb,
lib/yard-api/options.rb,
lib/yard-api/railtie.rb,
lib/yard-api/version.rb,
lib/yard-api/registry.rb,
lib/yard-api/verifier.rb,
lib/yard-api/serializer.rb,
lib/yard-api/yardoc_task.rb

Defined Under Namespace

Modules: Markup, Registry, Tags Classes: Options, Railtie, Serializer, Verifier, YardocTask

Constant Summary collapse

ROOT = 
File.dirname(__FILE__)
CONFIG_PATH = 
File.join(%W[#{ROOT} .. config])
TEMPLATE_PATH = 
File.join(%W[#{ROOT} .. templates])
TASK_PATH = 
File.join(%W[#{ROOT} .. tasks])
VERSION = 
"0.3.4"

Class Method Summary collapse

Class Method Details

.log(message, level = ::Logger::INFO) ⇒ Object 



35
36
37
38
 
# File 'lib/yard-api.rb', line 35

def self.log(message, level=::Logger::INFO)
  log = YARD::Logger.instance
  log.enter_level(level) { log.puts(message) }
end

.logger ⇒ Object 



40
41
42
 
# File 'lib/yard-api.rb', line 40

def self.logger
  YARD::Logger.instance
end

.on_error(message) ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/yard-api.rb', line 44

def self.on_error(message)
  if self.options.strict
    raise message
  else
    self.log(message, ::Logger::WARN)
  end
end

.options ⇒ Object 



31
32
33
 
# File 'lib/yard-api.rb', line 31

def self.options
  @@options ||= Options.new
end