Class/Module Index [+]

Quicksearch

YARD::Server::DocServerHelper

A module that is mixed into {Templates::Template} in order to customize certain template methods.

Public Instance Methods

base_path(path) click to toggle source

@example The base path for a library 'foo'

base_path('docs') # => 'docs/foo'

@param [String] path the path prefix for a base path URI @return [String] the base URI for a library with an extra path prefix

# File lib/yard/server/doc_server_helper.rb, line 32
def base_path(path)
  path + (@single_library ? '' : "/#{@library}")
end
router() click to toggle source

@return [Router] convenience method for accessing the router

# File lib/yard/server/doc_server_helper.rb, line 37
def router; @adapter.router end
url_for(obj, anchor = nil, relative = false) click to toggle source

Modifies {Templates::Helpers::HtmlHelper#url_for} to return a URL instead of a disk location. @param (see Templates::Helpers::HtmlHelper#url_for) @return (see Templates::Helpers::HtmlHelper#url_for)

# File lib/yard/server/doc_server_helper.rb, line 10
def url_for(obj, anchor = nil, relative = false)
  return '' if obj.nil?
  return "/#{obj}" if String === obj
  super(obj, anchor, false)
end
url_for_file(filename, anchor = nil) click to toggle source

Modifies {Templates::Helpers::HtmlHelper#url_for_file} to return a URL instead of a disk location. @param (see Templates::Helpers::HtmlHelper#url_for_file) @return (see Templates::Helpers::HtmlHelper#url_for_file)

# File lib/yard/server/doc_server_helper.rb, line 20
def url_for_file(filename, anchor = nil)
  if filename.is_a?(CodeObjects::ExtraFileObject)
    filename = filename.filename
  end
  "/#{base_path(router.docs_prefix)}/file/" + filename.sub(%{^#{@library.source_path.to_s}/}, '') +
    (anchor ? "##{anchor}" : "")
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.