Top Level Namespace

Defined Under Namespace

Modules: YARD Classes: Array, File, Hash, Insertion, Module, String, SymbolHash

Global Convenience Methods

• #log ⇒ YARD::Logger

  The global YARD::Logger instance.

• #P(namespace, name = nil, type = nil) ⇒ Object

  Shortcut for creating a YARD::CodeObjects::Proxy via a path.

Instance Method Details

#log ⇒ YARD::Logger

The global YARD::Logger instance

Returns:

• (YARD::Logger) —

  the global YARD::Logger instance

See Also:

• YARD::Logger

# File 'lib/yard/globals.rb', line 16

def log
  YARD::Logger.instance
end

#P(namespace, name = nil, type = nil) ⇒ Object

Shortcut for creating a YARD::CodeObjects::Proxy via a path

See Also:

• YARD::CodeObjects::Proxy
• YARD::Registry.resolve

# File 'lib/yard/globals.rb', line 7

def P(namespace, name = nil, type = nil)
  namespace, name = nil, namespace if name.nil?
  YARD::Registry.resolve(namespace, name, false, true, type)
end