Skip to Content Skip to Search

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.

rdoc:coverage

Print RDoc coverage report for all rdoc files.

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.rdoc"
  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, :rdoc:force, and :rdoc:coverage.

Methods
B
C
D
N
O
R

Attributes

[RW] external

Whether to run the rdoc process as an external shell (default is false)
[RW] generator

Name of format generator (--format) used by rdoc. (defaults to rdoc’s default)
[RW] main

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

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

Name of the main, top level task. (default is :rdoc)
[RW] options

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

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

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

Name of template to be used by rdoc. (defaults to rdoc’s default)
[RW] title

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

Class Public methods

new(name = :rdoc)

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

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 158
def initialize name = :rdoc # :yield: self
  defaults

  check_names name

  @name = name

  yield self if block_given?

  define
end

Instance Public methods

before_running_rdoc(&block)

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.

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 288
def before_running_rdoc(&block)
  @before_running_rdoc = block
end

check_names(names)

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

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 174
def check_names names
  return unless Hash === names

  invalid_options =
    names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]

  unless invalid_options.empty? then
    raise ArgumentError, "invalid options: #{invalid_options.join ', '}"
  end
end

clobber_task_description()

Task description for the clobber rdoc task or its renamed equivalent

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 188
def clobber_task_description
  "Remove RDoc HTML files"
end

coverage_task_description()

Task description for the coverage task or its renamed description

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 309
def coverage_task_description
  "Print RDoc coverage report"
end

defaults()

Sets default task values

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 195
def defaults
  @name = :rdoc
  @rdoc_files = Rake::FileList.new
  @rdoc_dir = 'html'
  @main = nil
  @title = nil
  @template = nil
  @generator = nil
  @options = []
end

define()

Create the tasks defined by this task lib.

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 224
def define
  desc rdoc_task_description
  task rdoc_task_name

  desc rerdoc_task_description
  task rerdoc_task_name => [clobber_task_name, rdoc_task_name]

  desc clobber_task_description
  task clobber_task_name do
    rm_r @rdoc_dir rescue nil
  end

  task :clobber => [clobber_task_name]

  directory @rdoc_dir

  rdoc_target_deps = [
    @rdoc_files,
    Rake.application.rakefile
  ].flatten.compact

  task rdoc_task_name => [rdoc_target]
  file rdoc_target => rdoc_target_deps do
    @before_running_rdoc.call if @before_running_rdoc
    args = option_list + @rdoc_files

    $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
    RDoc::RDoc.new.document args
  end

  namespace rdoc_task_name do
    desc coverage_task_description
    task coverage_task_name do
      @before_running_rdoc.call if @before_running_rdoc
      opts = option_list << "-C"
      args = opts + @rdoc_files

      $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
      RDoc::RDoc.new.document args
    end
  end

  self
end

option_list()

List of options that will be supplied to RDoc

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 272
def option_list
  result = @options.dup
  result << "-o"       << @rdoc_dir
  result << "--main"   << main      if main
  result << "--markup" << markup    if markup
  result << "--title"  << title     if title
  result << "-T"       << template  if template
  result << '-f'       << generator if generator
  result
end

rdoc_task_description()

Task description for the rdoc task or its renamed equivalent

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 295
def rdoc_task_description
  'Build RDoc HTML files'
end

rerdoc_task_description()

Task description for the rerdoc task or its renamed description

Source: show | on GitHub 

# File ruby/lib/rdoc/task.rb, line 302
def rerdoc_task_description
  "Rebuild RDoc HTML files"
end