Parent

Class/Module Index [+]

Quicksearch

Gem::DocManager

Public Class Methods

load_yardoc() click to toggle source
# File lib/yard/rubygems/doc_manager.rb, line 5
def self.load_yardoc
  require File.expand_path(File.join(File.dirname(__FILE__), *%(.. .. yard)))
end

Public Instance Methods

install_rdoc() click to toggle source
Also aliased as: install_rdoc_yard_orig
Alias for: install_rdoc_yard
install_rdoc_yard() click to toggle source
# File lib/yard/rubygems/doc_manager.rb, line 70
def install_rdoc_yard
  if @spec.has_rdoc?
    install_rdoc_yard_orig
  elsif @spec.has_yardoc?
    install_yardoc
  end
end
Also aliased as: install_rdoc
install_rdoc_yard_orig() click to toggle source
Alias for: install_rdoc
install_ri() click to toggle source
Also aliased as: install_ri_yard_orig
Alias for: install_ri_yard
install_ri_yard() click to toggle source
# File lib/yard/rubygems/doc_manager.rb, line 58
def install_ri_yard
  install_ri_yard_orig if @spec.has_rdoc?
  return if @spec.has_rdoc? == false
  return if @spec.has_yardoc?

  self.class.load_yardoc
  say "Building YARD (yri) index for #{@spec.full_name}..."
  run_yardoc '-c', '-n'
end
Also aliased as: install_ri
install_ri_yard_orig() click to toggle source
Alias for: install_ri
install_yardoc() click to toggle source
# File lib/yard/rubygems/doc_manager.rb, line 49
def install_yardoc
  rdoc_dir = File.join(@doc_dir, 'rdoc')

  FileUtils.rm_rf rdoc_dir

  say "Installing YARD documentation for #{@spec.full_name}..."
  run_yardoc '-o', rdoc_dir
end
run_yardoc(*args) click to toggle source
# File lib/yard/rubygems/doc_manager.rb, line 9
def run_yardoc(*args)
  args << '--quiet'
  args << '--backtrace' if Gem.configuration.backtrace
  unless File.file?(File.join(@spec.full_gem_path, '.yardopts'))
    args << @spec.require_paths
    if @spec.extra_rdoc_files.size > 0
      args << '-'
      args += @spec.extra_rdoc_files
    end
  end
  args = args.flatten.map {|arg| arg.to_s }

  old_pwd = Dir.pwd
  Dir.chdir(@spec.full_gem_path)
  YARD::CLI::Yardoc.run(*args)
rescue Errno::EACCES => e
  dirname = File.dirname e.message.split("-")[1].strip
  raise Gem::FilePermissionError.new(dirname)
rescue => ex
  alert_error "While generating documentation for #{@spec.full_name}"
  ui.errs.puts "... MESSAGE:   #{ex}"
  ui.errs.puts "... YARDOC args: #{args.join(' ')}"
  ui.errs.puts "\t#{ex.backtrace.join("\n\t")}" if Gem.configuration.backtrace
  ui.errs.puts "(continuing with the rest of the installation)"
ensure
  Dir.chdir(old_pwd)
end
setup_rdoc() click to toggle source
# File lib/yard/rubygems/doc_manager.rb, line 38
def setup_rdoc
  if File.exist?(@doc_dir) && !File.writable?(@doc_dir) then
    raise Gem::FilePermissionError.new(@doc_dir)
  end

  FileUtils.mkdir_p @doc_dir unless File.exist?(@doc_dir)

  self.class.load_rdoc if @spec.has_rdoc?
  self.class.load_yardoc if @spec.has_yardoc?
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.