class Object
Constants
- RUBY18
Keep track of Ruby version for compatibility code @deprecated Use {YARD.ruby18?} or {YARD.ruby19?} instead.
- RUBY19
Public Instance Methods
P(namespace, name = nil, type = nil)
click to toggle source
Shortcut for creating a YARD::CodeObjects::Proxy
via a path
@see YARD::CodeObjects::Proxy
@see YARD::Registry.resolve
# File lib/yard/globals.rb, line 8 def P(namespace, name = nil, type = nil) # rubocop:disable Naming/MethodName if name.nil? name = namespace namespace = nil end YARD::Registry.resolve(namespace, name, false, true, type) end
__p(path)
click to toggle source
@private
# File lib/yard/autoload.rb, line 3 def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end
init()
click to toggle source
Calls superclass method
# File lib/yard/server/templates/default/method_details/html/setup.rb, line 2 def init super sections.place(:permalink).after_any(:method_signature) end
javascripts()
click to toggle source
Calls superclass method
# File lib/yard/server/templates/default/layout/html/setup.rb, line 2 def javascripts super + %w(js/autocomplete.js) end
log()
click to toggle source
The global {YARD::Logger} instance
@return [YARD::Logger] the global {YARD::Logger} instance @see YARD::Logger
# File lib/yard/globals.rb, line 20 def log YARD::Logger.instance end
search()
click to toggle source
# File lib/yard/server/templates/doc_server/search/html/setup.rb, line 6 def search options.breadcrumb_title = h("Search for '#{@query}'") yieldall :contents => erb(:search) end
stylesheets()
click to toggle source
Calls superclass method
# File lib/yard/server/templates/default/layout/html/setup.rb, line 6 def stylesheets super + %w(css/custom.css) end