123456789_123456789_123456789_123456789_123456789_

Class: RDoc::RI::Task

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RDoc::Task, Rake::TaskLib
Instance Chain:
self, ::RDoc::Task, Rake::TaskLib
Inherits: RDoc::Task
Defined in: lib/rdoc/ri/task.rb

Overview

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

Class Method Summary

::RDoc::Task - Inherited

.new

Create an ::RDoc::RDoc task with the given name.

Instance Attribute Summary

::RDoc::Task - Inherited

#external

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

Name of format generator (--format) used by rdoc.
#main

Name of file to be used as the main, top level file of the ::RDoc::RDoc.
#markup

The markup format; one of: rdoc (the default), markdown, rd, tomdoc.
#name

Name of the main, top level task.
#options

Additional list of options to be passed rdoc.
#rdoc_dir

Name of directory to receive the html output files.
#rdoc_files

List of files to be included in the rdoc generation.
#template

Name of template to be used by rdoc.
#title

Title of ::RDoc::RDoc documentation.
#inline_source

All source is inline now.
#inline_source=

All source is inline now.

Instance Method Summary

::RDoc::Task - Inherited

#before_running_rdoc

The block passed to this method will be called just before running the ::RDoc::RDoc generator.
#check_names

Ensures that names only includes names for the :rdoc, :clobber_rdoc and :rerdoc.
#clobber_task_description

Task description for the clobber rdoc task or its renamed equivalent.
#coverage_task_description

Task description for the coverage task or its renamed description.
#defaults

Sets default task values.
#define

Create the tasks defined by this task lib.
#option_list

List of options that will be supplied to ::RDoc::RDoc.
#rdoc_task_description

Task description for the rdoc task or its renamed equivalent.
#rerdoc_task_description

Task description for the rerdoc task or its renamed description.
#clobber_task_name, #coverage_task_name, #rdoc_target, #rdoc_task_name, #rerdoc_task_name

Constructor Details

.new(name = DEFAULT_NAMES) ⇒ Task

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

[ GitHub ] 

  


# File 'lib/rdoc/ri/task.rb', line 47



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


  







Instance Method Details



  

    #clobber_task_description  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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


  








  

    #defaults  
  



  

    
Sets default task values

  



  [ GitHub ]


  

  


# File 'lib/rdoc/ri/task.rb', line 58



def defaults
  super

  @rdoc_dir = '.rdoc'
end


  








  

    #rdoc_task_description  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rdoc/ri/task.rb', line 64



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


  








  

    #rerdoc_task_description  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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