PHP 8.2.31
Preview: rdoc_command.rb Size: 2.24 KB
//proc/thread-self/root/opt/alt/ruby19/lib64/ruby/1.9.1/rubygems/commands/rdoc_command.rb

require 'rubygems/command'
require 'rubygems/version_option'
require 'rubygems/doc_manager'

class Gem::Commands::RdocCommand < Gem::Command
  include Gem::VersionOption

  def initialize
    super 'rdoc', 'Generates RDoc for pre-installed gems',
          :version => Gem::Requirement.default,
          :include_rdoc => true, :include_ri => true, :overwrite => false

    add_option('--all',
               'Generate RDoc/RI documentation for all',
               'installed gems') do |value, options|
      options[:all] = value
    end

    add_option('--[no-]rdoc',
               'Generate RDoc HTML') do |value, options|
      options[:include_rdoc] = value
    end

    add_option('--[no-]ri',
               'Generate RI data') do |value, options|
      options[:include_ri] = value
    end

    add_option('--[no-]overwrite',
               'Overwrite installed documents') do |value, options|
      options[:overwrite] = value
    end

    add_version_option
  end

  def arguments # :nodoc:
    "GEMNAME       gem to generate documentation for (unless --all)"
  end

  def defaults_str # :nodoc:
    "--version '#{Gem::Requirement.default}' --rdoc --ri --no-overwrite"
  end

  def description # :nodoc:
    <<-DESC
The rdoc command builds RDoc and RI documentation for installed gems.  Use
--overwrite to force rebuilding of documentation.
    DESC
  end

  def usage # :nodoc:
    "#{program_name} [args]"
  end

  def execute
    if options[:all] then
      specs = Gem::SourceIndex.from_installed_gems.collect { |name, spec|
        spec
      }
    else
      gem_name = get_one_gem_name
      dep = Gem::Dependency.new gem_name, options[:version]
      specs = Gem::SourceIndex.from_installed_gems.search dep
    end

    if specs.empty?
      raise "Failed to find gem #{gem_name} to generate RDoc for #{options[:version]}"
    end

    if options[:include_ri]
      specs.sort.each do |spec|
        doc = Gem::DocManager.new(spec)
        doc.generate_ri if options[:overwrite] || !doc.ri_installed?
      end

      Gem::DocManager.update_ri_cache
    end

    if options[:include_rdoc]
      specs.sort.each do |spec|
        doc = Gem::DocManager.new(spec)
        doc.generate_rdoc if options[:overwrite] || !doc.rdoc_installed?
      end
    end

    true
  end

end

Directory Contents

Dirs: 0 × Files: 29

Name Size Perms Modified Actions
1.25 KB lrw-r--r-- 2012-04-19 22:43:16
Edit Download
2.74 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
1.64 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
2.59 KB lrw-r--r-- 2011-08-05 20:18:14
Edit Download
2.59 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
4.19 KB lrw-r--r-- 2011-10-08 10:53:11
Edit Download
3.90 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
1.85 KB lrw-r--r-- 2012-04-19 22:43:16
Edit Download
3.86 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
4.43 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
4.83 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
696 B lrw-r--r-- 2011-07-27 02:04:03
Edit Download
2.67 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
785 B lrw-r--r-- 2011-07-27 02:04:03
Edit Download
1.70 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
3.20 KB lrw-r--r-- 2012-04-19 22:43:16
Edit Download
1.31 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
7.38 KB lrw-r--r-- 2011-10-08 10:53:11
Edit Download
2.24 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
582 B lrw-r--r-- 2011-07-27 02:04:03
Edit Download
2.35 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
9.45 KB lrw-r--r-- 2012-04-19 22:43:16
Edit Download
3.27 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
3.04 KB lrw-r--r-- 2012-04-19 22:43:16
Edit Download
704 B lrw-r--r-- 2011-07-27 02:04:03
Edit Download
2.49 KB lrw-r--r-- 2011-08-26 01:12:57
Edit Download
4.03 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
6.04 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download
1.87 KB lrw-r--r-- 2011-07-27 02:04:03
Edit Download

If ZipArchive is unavailable, a .tar will be created (no compression).