PHP 8.2.31
Preview: rdoc_command.rb Size: 2.31 KB
/proc/thread-self/root/opt/alt/ruby20/lib64/ruby/2.0.0/rubygems/commands/rdoc_command.rb

require 'rubygems/command'
require 'rubygems/version_option'
require 'rubygems/rdoc'
require 'fileutils'

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 => false, :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}' --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
    specs = if options[:all] then
              Gem::Specification.to_a
            else
              get_all_gem_names.map do |name|
                Gem::Specification.find_by_name name, options[:version]
              end.flatten.uniq
            end

    if specs.empty? then
      alert_error 'No matching gems found'
      terminate_interaction 1
    end

    specs.each do |spec|
      doc = Gem::RDoc.new spec, options[:include_rdoc], options[:include_ri]

      doc.force = options[:overwrite]

      if options[:overwrite] then
        FileUtils.rm_rf File.join(spec.doc_dir, 'ri')
        FileUtils.rm_rf File.join(spec.doc_dir, 'rdoc')
      end

      begin
        doc.generate
      rescue Errno::ENOENT => e
        e.message =~ / - /
        alert_error "Unable to document #{spec.full_name}, #{$'} is missing, skipping"
        terminate_interaction 1 if specs.length == 1
      end
    end
  end

end

Directory Contents

Dirs: 0 × Files: 31

Name Size Perms Modified Actions
859 B lrw-r--r-- 2012-11-29 06:52:18
Edit Download
6.41 KB lrw-r--r-- 2013-06-21 16:16:31
Edit Download
2.01 KB lrw-r--r-- 2012-12-23 00:35:09
Edit Download
3.85 KB lrw-r--r-- 2013-01-04 22:58:15
Edit Download
3.12 KB lrw-r--r-- 2012-11-30 00:23:15
Edit Download
3.89 KB lrw-r--r-- 2012-11-29 06:52:18
Edit Download
4.16 KB lrw-r--r-- 2012-11-29 06:52:18
Edit Download
1.49 KB lrw-r--r-- 2013-09-15 14:23:26
Edit Download
2.52 KB lrw-r--r-- 2012-11-29 06:52:18
Edit Download
4.56 KB lrw-r--r-- 2013-07-22 16:33:18
Edit Download
5.45 KB lrw-r--r-- 2012-12-06 05:26:46
Edit Download
696 B lrw-r--r-- 2013-07-22 16:33:18
Edit Download
2.67 KB lrw-r--r-- 2012-11-29 06:52:18
Edit Download
395 B lrw-r--r-- 2012-11-29 06:52:18
Edit Download
866 B lrw-r--r-- 2012-11-29 06:52:18
Edit Download
1.84 KB lrw-r--r-- 2013-07-22 16:33:18
Edit Download
3.66 KB lrw-r--r-- 2013-08-16 15:35:06
Edit Download
2.02 KB lrw-r--r-- 2013-07-22 16:33:18
Edit Download
8.03 KB lrw-r--r-- 2013-07-25 15:42:22
Edit Download
2.31 KB lrw-r--r-- 2012-12-14 05:09:37
Edit Download
616 B lrw-r--r-- 2013-07-25 15:42:22
Edit Download
2.35 KB lrw-r--r-- 2012-11-29 06:52:18
Edit Download
12.94 KB lrw-r--r-- 2013-07-22 16:33:18
Edit Download
3.62 KB lrw-r--r-- 2013-03-17 14:18:23
Edit Download
2.93 KB lrw-r--r-- 2013-07-22 16:33:18
Edit Download
704 B lrw-r--r-- 2011-07-27 01:40:07
Edit Download
3.07 KB lrw-r--r-- 2012-12-06 05:26:46
Edit Download
4.06 KB lrw-r--r-- 2012-11-29 06:52:18
Edit Download
5.80 KB lrw-r--r-- 2013-07-22 16:33:18
Edit Download
1.87 KB lrw-r--r-- 2011-07-27 01:40:07
Edit Download
2.40 KB lrw-r--r-- 2012-11-29 08:10:23
Edit Download

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