Method: YARD::Config.load_plugin

Defined in:
lib/yard/config.rb

.load_plugin(name) ⇒ Boolean

Loads an individual plugin by name. It is not necessary to include the yard- plugin prefix here.

Parameters:

  • name (String) —

    the name of the plugin (with or without yard- prefix)

Returns:

  • (Boolean) —

    whether the plugin was successfully loaded

Since:

  • 0.6.2


153
154
155
156
157
158
159
160
161
162
 
# File 'lib/yard/config.rb', line 153

def self.load_plugin(name)
  name = translate_plugin_name(name)
  return false if options[:ignored_plugins].include?(name)
  return false if name =~ /^yard-doc-/
  log.debug "Loading plugin '#{name}'..."
  require name
  true
rescue LoadError => e
  load_plugin_failed(name, e)
end