Class

RDoc::Task creates the following rake tasks to generate and clean up RDoc output:

rdoc

Main task for this RDoc task.

clobber_rdoc

Delete all the rdoc files. This target is automatically added to the main clobber target.

rerdoc

Rebuild the rdoc files from scratch, even if they are not out of date.

Simple Example:

require 'rdoc/task'

RDoc::Task.new do |rdoc|
  rdoc.main = "README.rdoc"
  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
end

The rdoc object passed to the block is an RDoc::Task object. See the attributes list for the RDoc::Task class for available customization options.

Specifying different task names

You may wish to give the task a different name, such as if you are generating two sets of documentation. For instance, if you want to have a development set of documentation including private methods:

require 'rdoc/task'

RDoc::Task.new :rdoc_dev do |rdoc|
  rdoc.main = "README.doc"
  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
  rdoc.options << "--all"
end

The tasks would then be named :rdoc_dev, :clobber_rdoc_dev, and :rerdoc_dev.

If you wish to have completely different task names, then pass a Hash as first argument. With the :rdoc, :clobber_rdoc and :rerdoc options, you can customize the task names to your liking.

For example:

require 'rdoc/task'

RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
               :rerdoc => "rdoc:force")

This will create the tasks :rdoc, :rdoc:clean and :rdoc:force.

Attributes
Read & Write

Name of the main, top level task. (default is :rdoc)

Read & Write

Comment markup format. rdoc, rd and tomdoc are supported. (default is ‘rdoc’)

Read & Write

Name of directory to receive the html output files. (default is “html”)

Read & Write

Title of RDoc documentation. (defaults to rdoc’s default)

Read & Write

Name of file to be used as the main, top level file of the RDoc. (default is none)

Read & Write

Name of template to be used by rdoc. (defaults to rdoc’s default)

Read & Write

Name of format generator (<tt>–format<tt>) used by rdoc. (defaults to rdoc’s default)

Read & Write

List of files to be included in the rdoc generation. (default is [])

Read & Write

Additional list of options to be passed rdoc. (default is [])

Read & Write

Whether to run the rdoc process as an external shell (default is false)

Class Methods

Create an RDoc task with the given name. See the RDoc::Task class overview for documentation.

Instance Methods

The block passed to this method will be called just before running the RDoc generator. It is allowed to modify RDoc::Task attributes inside the block.

Ensures that names only includes names for the :rdoc, :clobber_rdoc and :rerdoc. If other names are given an ArgumentError is raised.

Task description for the clobber rdoc task or its renamed equivalent

No documentation available

Sets default task values

Create the tasks defined by this task lib.

List of options that will be supplied to RDoc

No documentation available

Task description for the rdoc task or its renamed equivalent

No documentation available

Task description for the rerdoc task or its renamed description

No documentation available