summaryrefslogtreecommitdiff
path: root/trunk/lib/rubygems/commands/rdoc_command.rb
diff options
context:
space:
mode:
authoryugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-08-25 15:02:05 +0000
committeryugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-08-25 15:02:05 +0000
commit0dc342de848a642ecce8db697b8fecd83a63e117 (patch)
tree2b7ed4724aff1f86073e4740134bda9c4aac1a39 /trunk/lib/rubygems/commands/rdoc_command.rb
parentef70cf7138ab8034b5b806f466e4b484b24f0f88 (diff)
added tag v1_9_0_4
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/tags/v1_9_0_4@18845 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'trunk/lib/rubygems/commands/rdoc_command.rb')
-rw-r--r--trunk/lib/rubygems/commands/rdoc_command.rb78
1 files changed, 78 insertions, 0 deletions
diff --git a/trunk/lib/rubygems/commands/rdoc_command.rb b/trunk/lib/rubygems/commands/rdoc_command.rb
new file mode 100644
index 0000000000..f2e677c115
--- /dev/null
+++ b/trunk/lib/rubygems/commands/rdoc_command.rb
@@ -0,0 +1,78 @@
+require 'rubygems/command'
+require 'rubygems/version_option'
+require 'rubygems/doc_manager'
+
+module Gem
+ module Commands
+ class RdocCommand < Command
+ include VersionOption
+
+ def initialize
+ super('rdoc',
+ 'Generates RDoc for pre-installed gems',
+ {
+ :version => Gem::Requirement.default,
+ :include_rdoc => true,
+ :include_ri => true,
+ })
+ add_option('--all',
+ 'Generate RDoc/RI documentation for all',
+ 'installed gems') do |value, options|
+ options[:all] = value
+ end
+ add_option('--[no-]rdoc',
+ 'Include RDoc generated documents') do
+ |value, options|
+ options[:include_rdoc] = value
+ end
+ add_option('--[no-]ri',
+ 'Include RI generated documents'
+ ) do |value, options|
+ options[:include_ri] = 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"
+ end
+
+ def usage # :nodoc:
+ "#{program_name} [args]"
+ end
+
+ def execute
+ if options[:all]
+ specs = Gem::SourceIndex.from_installed_gems.collect { |name, spec|
+ spec
+ }
+ else
+ gem_name = get_one_gem_name
+ specs = Gem::SourceIndex.from_installed_gems.search(
+ gem_name, options[:version])
+ end
+
+ if specs.empty?
+ fail "Failed to find gem #{gem_name} to generate RDoc for #{options[:version]}"
+ end
+ if options[:include_ri]
+ specs.each do |spec|
+ Gem::DocManager.new(spec).generate_ri
+ end
+ end
+ if options[:include_rdoc]
+ specs.each do |spec|
+ Gem::DocManager.new(spec).generate_rdoc
+ end
+ end
+
+ true
+ end
+ end
+
+ end
+end