Class Gem::Commands::RdocCommand
In: lib/rubygems/commands/rdoc_command.rb
Parent: Command

Methods

execute   new  

Included Modules

VersionOption

Public Class methods

[Source]

    # File lib/rubygems/commands/rdoc_command.rb, line 10
10:       def initialize
11:         super('rdoc',
12:           'Generates RDoc for pre-installed gems',
13:           {
14:             :version => Gem::Requirement.default,
15:             :include_rdoc => true,
16:             :include_ri => true,
17:           })
18:         add_option('--all',
19:                    'Generate RDoc/RI documentation for all',
20:                    'installed gems') do |value, options|
21:           options[:all] = value
22:         end
23:         add_option('--[no-]rdoc', 
24:           'Include RDoc generated documents') do
25:           |value, options|
26:           options[:include_rdoc] = value
27:         end
28:         add_option('--[no-]ri', 
29:           'Include RI generated documents'
30:           ) do |value, options|
31:           options[:include_ri] = value
32:         end
33:         add_version_option
34:       end

Public Instance methods

[Source]

    # File lib/rubygems/commands/rdoc_command.rb, line 48
48:       def execute
49:         if options[:all]
50:           specs = Gem::SourceIndex.from_installed_gems.collect { |name, spec|
51:             spec
52:           }
53:         else
54:           gem_name = get_one_gem_name
55:           specs = Gem::SourceIndex.from_installed_gems.search(
56:             gem_name, options[:version])
57:         end
58: 
59:         if specs.empty?
60:           fail "Failed to find gem #{gem_name} to generate RDoc for #{options[:version]}"
61:         end
62: 
63:         if options[:include_ri]
64:           specs.each do |spec|
65:             Gem::DocManager.new(spec).generate_ri
66:           end
67: 
68:           Gem::DocManager.update_ri_cache
69:         end
70: 
71:         if options[:include_rdoc]
72:           specs.each do |spec|
73:             Gem::DocManager.new(spec).generate_rdoc
74:           end
75:         end
76: 
77:         true
78:       end

[Validate]