Parent

Methods

Included Modules

Class Index [+]

Quicksearch

Gem::Commands::RdocCommand

Public Class Methods

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

Public Instance Methods

execute() click to toggle source
    # File lib/rubygems/commands/rdoc_command.rb, line 56
56:   def execute
57:     if options[:all] then
58:       specs = Gem::SourceIndex.from_installed_gems.collect { |name, spec|
59:         spec
60:       }
61:     else
62:       gem_name = get_one_gem_name
63:       dep = Gem::Dependency.new gem_name, options[:version]
64:       specs = Gem::SourceIndex.from_installed_gems.search dep
65:     end
66: 
67:     if specs.empty?
68:       raise "Failed to find gem #{gem_name} to generate RDoc for #{options[:version]}"
69:     end
70: 
71:     if options[:include_ri]
72:       specs.sort.each do |spec|
73:         doc = Gem::DocManager.new(spec)
74:         doc.generate_ri if options[:overwrite] || !doc.ri_installed?
75:       end
76: 
77:       Gem::DocManager.update_ri_cache
78:     end
79: 
80:     if options[:include_rdoc]
81:       specs.sort.each do |spec|
82:         doc = Gem::DocManager.new(spec)
83:         doc.generate_rdoc if options[:overwrite] || !doc.rdoc_installed?
84:       end
85:     end
86: 
87:     true
88:   end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.