class Gem::Commands::RdocCommand - Documentation for Ruby 4.0
Description: Documentation for the Gem::Commands::RdocCommand class
Keywords: ruby,class,Gem::Commands::RdocCommand

🔍

No recent searches

# class Gem::Commands::RdocCommand

### Public Class Methods

new ()
Source

    # File lib/rubygems/commands/rdoc_command.rb, line 11
    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

Calls superclass method `Gem::Command::new`

### Public Instance Methods

execute ()
Source

    # File lib/rubygems/commands/rdoc_command.rb, line 63
    def execute
      specs = if options[:all]
        Gem::Specification.to_a
      else
        get_all_gem_names.flat_map do |name|
          Gem::Specification.find_by_name name, options[:version]
        end.uniq
      end

      if specs.empty?
        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]
          FileUtils.rm_rf File.join(spec.doc_dir, "ri")
          FileUtils.rm_rf File.join(spec.doc_dir, "rdoc")
        end

        doc.generate
      end
    end