Class: Gem::DocManager

Class | Gem::DocManager
In: | lib/rubygems/doc_manager.rb
Parent: | Object

### Methods

configured_args configured_args= generate_rdoc generate_ri install_rdoc install_ri load_rdoc new rdoc_installed? run_rdoc uninstall_doc

### Included Modules

UserInteraction

### Public Class methods

configured_args()
configured_args=(args)
new(spec, rdoc_args="")

Create a document manager for the given gem spec.

spec: | The Gem::Specification object representing the gem.
rdoc_args: | Optional arguments for RDoc (template etc.) as a String.

### Public Instance methods

generate_rdoc()

Generate the RDoc documents for this gem spec.

Note that if both RI and RDoc documents are generated from the same process, the RI docs should be done first (a likely bug in RDoc will cause RI docs generation to fail if run after RDoc).

generate_ri()

Generate the RI documents for this gem spec.

Note that if both RI and RDoc documents are generated from the same process, the RI docs should be done first (a likely bug in RDoc will cause RI docs generation to fail if run after RDoc).

install_rdoc()
install_ri()
load_rdoc()

Load the RDoc documentation generator library.

rdoc_installed?()

Is the RDoc documentation installed?

run_rdoc(*args)
uninstall_doc()

[Validate]