Parent

Included Modules

Class/Module Index [+]

Quicksearch

YARD::Server::DocServerSerializer

A custom {Serializers::Base serializer} which returns resource URLs instead of static relative paths to files on disk.

Public Class Methods

new(command) click to toggle source
# File lib/yard/server/doc_server_serializer.rb, line 10
def initialize(command)
  super(:command => command, :extension => '')
end

Public Instance Methods

serialized_path(object) click to toggle source
# File lib/yard/server/doc_server_serializer.rb, line 14
def serialized_path(object)
  path = case object
  when CodeObjects::RootObject
    "toplevel"
  when CodeObjects::MethodObject
    return escape_path(serialized_path(object.namespace) + (object.scope == :instance ? ":" : ".") + object.name.to_s)
  when CodeObjects::ConstantObject, CodeObjects::ClassVariableObject
    return escape_path(serialized_path(object.namespace)) + "##{object.name}-#{object.type}"
  else
    object.path.gsub('::', '/')
  end
  command = options[:command]
  library_path = command.single_library ? '' : '/' + command.library.to_s
  return escape_path(File.join('', command.adapter.router.docs_prefix, library_path, path))
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.