Parent

Included Modules

Class/Module Index [+]

Quicksearch

Object

Public Instance Methods

P(namespace, name = 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 7
def P(namespace, name = nil)
  namespace, name = nil, namespace if name.nil?
  YARD::Registry.resolve(namespace, name, false, true)
end
__p(path) click to toggle source

@private

# File lib/yard/autoload.rb, line 2
def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end
asset(file, contents) click to toggle source
# File lib/yard/server/templates/doc_server/full_list/html/setup.rb, line 18
def asset(file, contents)
  contents
end
init() click to toggle source
# File lib/yard/server/templates/doc_server/full_list/html/setup.rb, line 3
def init
  case @list_type.to_sym
  when :class
    generate_class_list
    @list_title = "Class List"
  when :methods
    generate_method_list
    @list_title = "Method List"
  when :files
    generate_file_list
    @list_title = "File List"
  end
  sections :full_list
end
javascripts() click to toggle source
# File lib/yard/server/templates/default/layout/html/setup.rb, line 1
def javascripts
  super + %(js/autocomplete.js js/live.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 16
def log
  YARD::Logger.instance
end
search() click to toggle source
# File lib/yard/server/templates/doc_server/search/html/setup.rb, line 5
def search
  options[:breadcrumb_title] = h("Search for '#{@query}'")
  yieldall :contents => erb(:search)
end
stylesheets() click to toggle source
# File lib/yard/server/templates/default/layout/html/setup.rb, line 5
def stylesheets
  super + %(css/custom.css)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.