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.
Methods
Constants
| DEFAULT_NAMES | = | { # :nodoc: :clobber_rdoc => :clobber_ri, :rdoc => :ri, :rerdoc => :reri, } |
Class Public methods
new(name = DEFAULT_NAMES)
Link
Create an ri task with the given name. See RDoc::Task for documentation on setting names.
Instance Public methods