Class: RDoc::RI::Task

Inherits:
Task
  • Object
show all
Defined in:
lib/rdoc/ri/task.rb

Overview

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.md'
ri.rdoc_files.include 'README.md', 'lib/**/*.rb'
end

For further configuration details see RDoc::Task.

Constant Summary collapse

DEFAULT_NAMES =

:nodoc:

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

Instance Attribute Summary

Attributes inherited from Task

#external, #generator, #main, #markup, #name, #options, #rdoc_dir, #rdoc_files, #template, #title

Instance Method Summary collapse

Methods inherited from Task

#before_running_rdoc, #check_names, #coverage_task_description, #define, #option_list, #server_task_description

Constructor Details

#initialize(name = DEFAULT_NAMES) ⇒ Task

Create an ri task with the given name. See RDoc::Task for documentation on setting names.



49
50
51
 
# File 'lib/rdoc/ri/task.rb', line 49

def initialize(name = DEFAULT_NAMES) # :yield: self
  super
end

Instance Method Details

#clobber_task_description ⇒ Object

:nodoc:



53
54
55
 
# File 'lib/rdoc/ri/task.rb', line 53

def clobber_task_description # :nodoc:
  "Remove RI data files"
end

#defaults ⇒ Object

Sets default task values



60
61
62
63
64
 
# File 'lib/rdoc/ri/task.rb', line 60

def defaults
  super

  @rdoc_dir = '.rdoc'
end

#rdoc_task_description ⇒ Object

:nodoc:



66
67
68
 
# File 'lib/rdoc/ri/task.rb', line 66

def rdoc_task_description # :nodoc:
  'Build RI data files'
end

#rerdoc_task_description ⇒ Object

:nodoc:



70
71
72
 
# File 'lib/rdoc/ri/task.rb', line 70

def rerdoc_task_description # :nodoc:
  'Rebuild RI data files'
end