class

RDoc::RI::Task

ruby latest stable - Superclass: RDoc::Task

Class deprecated or moved

This class is deprecated or moved on the latest stable version. The last existing version (v2_2_9) is shown here.

RDoc::RI::Task creates ri data in ./.rdoc for your project.

It contains the following tasks:

ri

Build ri data

clobber_ri

Delete ri data files. This target is automatically added to the main clobber target.

reri

Rebuild the ri data from scratch even if they are not out of date.

Simple example:

require 'rdoc/ri/task'

RDoc::RI::Task.new do |ri|
  ri.main = 'README.rdoc'
  ri.rdoc_files.include 'README.rdoc', 'lib/**/*.rb'
end

For further configuration details see RDoc::Task.

Constants

DEFAULT_NAMES = { # :nodoc:\n:clobber_rdoc => :clobber_ri,\n:rdoc => :ri,\n:rerdoc => :reri,\n}

Files

  • lib/rdoc/ri/task.rb