class Rake::RDocTask

NOTE: Rake::RDocTask is deprecated in favor of RDoc:Task which is included in RDoc 2.4.2+. Use require 'rdoc/task' to require it.

Create a documentation task that will generate the RDoc files for a project.

The RDocTask will create the following targets:

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:

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

The rd object passed to the block is an RDocTask object. See the attributes list for the RDocTask 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:

Rake::RDocTask.new(:rdoc_dev) do |rd|
  rd.main = "README.doc"
  rd.rdoc_files.include("README.rdoc", "lib/   *.rb")
  rd.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:

Rake::RDocTask.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean", :rerdoc => "rdoc:force")

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

Attributes

external[RW]

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

inline_source[RW]
main[RW]

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

name[RW]

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

options[RW]

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

rdoc_dir[RW]

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

rdoc_files[RW]

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

template[RW]

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

title[RW]

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

Public Class Methods

new(name = :rdoc) { |self| ... } click to toggle source

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

# File lib/rake/rdoctask.rb, line 108
def initialize(name = :rdoc)  # :yield: self
  if name.is_a?(Hash)
    invalid_options = name.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]
    if !invalid_options.empty?
      raise ArgumentError, "Invalid option(s) passed to RDocTask.new: #{invalid_options.join(", ")}"
    end
  end

  @name = name
  @rdoc_files = Rake::FileList.new
  @rdoc_dir = 'html'
  @main = nil
  @title = nil
  @template = nil
  @external = false
  @inline_source = true
  @options = []
  yield self if block_given?
  define
end

Public Instance Methods

before_running_rdoc(&block) click to toggle source

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

# File lib/rake/rdoctask.rb, line 190
def before_running_rdoc(&block)
  @before_running_rdoc = block
end
define() click to toggle source

Create the tasks defined by this task lib.

# File lib/rake/rdoctask.rb, line 130
def define
  if rdoc_task_name != "rdoc"
    desc "Build the RDOC HTML Files"
  else
    desc "Build the #{rdoc_task_name} HTML Files"
  end
  task rdoc_task_name

  desc "Force a rebuild of the RDOC files"
  task rerdoc_task_name => [clobber_task_name, rdoc_task_name]

  desc "Remove rdoc products"
  task clobber_task_name do
    rm_r rdoc_dir rescue nil
  end

  task :clobber => [clobber_task_name]

  directory @rdoc_dir
  task rdoc_task_name => [rdoc_target]
  file rdoc_target => @rdoc_files + [Rake.application.rakefile] do
    rm_r @rdoc_dir rescue nil
    @before_running_rdoc.call if @before_running_rdoc
    args = option_list + @rdoc_files
    if @external
      argstring = args.join(' ')
      sh %Q{ruby -Ivendor vendor/rd #{argstring}}
    else
      require 'rdoc/rdoc'
      RDoc::RDoc.new.document(args)
    end
  end
  self
end
option_list() click to toggle source
# File lib/rake/rdoctask.rb, line 165
def option_list
  result = @options.dup
  result << "-o" << @rdoc_dir
  result << "--main" << quote(main) if main
  result << "--title" << quote(title) if title
  result << "-T" << quote(template) if template
  result << "--inline-source" if inline_source && !@options.include?("--inline-source") && !@options.include?("-S")
  result
end
option_string() click to toggle source
# File lib/rake/rdoctask.rb, line 183
def option_string
  option_list.join(' ')
end
quote(str) click to toggle source
# File lib/rake/rdoctask.rb, line 175
def quote(str)
  if @external
    "'#{str}'"
  else
    str
  end
end

Private Instance Methods

clobber_task_name() click to toggle source
# File lib/rake/rdoctask.rb, line 209
def clobber_task_name
  case name
  when Hash
    (name[:clobber_rdoc] || "clobber_rdoc").to_s
  else
    "clobber_#{name}"
  end
end
rdoc_target() click to toggle source
# File lib/rake/rdoctask.rb, line 196
def rdoc_target
  "#{rdoc_dir}/index.html"
end
rdoc_task_name() click to toggle source
# File lib/rake/rdoctask.rb, line 200
def rdoc_task_name
  case name
  when Hash
    (name[:rdoc] || "rdoc").to_s
  else
    name.to_s
  end
end
rerdoc_task_name() click to toggle source
# File lib/rake/rdoctask.rb, line 218
def rerdoc_task_name
  case name
  when Hash
    (name[:rerdoc] || "rerdoc").to_s
  else
    "re#{name}"
  end
end