Top Level Namespace

Defined Under Namespace

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

Constant Summary collapse

RUBY18 =
Deprecated.

Use YARD.ruby18? or YARD.ruby19? instead.

Keep track of Ruby version for compatibility code

YARD.ruby18?
RUBY19 = 
YARD.ruby19?

Global Convenience Methods collapse

Instance Method Summary collapse

Instance Method Details

#__p(path) ⇒ Object 



3
 
# File 'lib/yard/autoload.rb', line 3

def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end

#init ⇒ Object 



2
3
4
 
# File 'lib/yard/server/templates/doc_server/search/html/setup.rb', line 2

def init
  sections :search, [T('../default/layout')]
end

#javascripts ⇒ Object 



2
3
4
 
# File 'lib/yard/server/templates/default/layout/html/setup.rb', line 2

def javascripts
  super + %w(js/autocomplete.js)
end

#log ⇒ YARD::Logger

The global YARD::Logger instance

Returns:

See Also:



20
21
22
 
# File 'lib/yard/globals.rb', line 20

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:



8
9
10
11
12
13
14
 
# 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

#search ⇒ Object 



6
7
8
9
 
# 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 ⇒ Object 



6
7
8
 
# File 'lib/yard/server/templates/default/layout/html/setup.rb', line 6

def stylesheets
  super + %w(css/custom.css)
end