Class: RDoc::Task

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

Overview

Task creates the following rake tasks to generate and clean up RDoc output:

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.
rdoc:coverage: Print RDoc coverage report for all rdoc files.

Simple Example:

require 'rdoc/task'

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

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

require 'rdoc/task'

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

require 'rdoc/task'

RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
               :rerdoc => "rdoc:force")

This will create the tasks :rdoc, :rdoc:clean, :rdoc:force, and :rdoc:coverage.

Class Method Summary

.new(name = :rdoc) {|_self| ... } ⇒ Task constructor

Create an RDoc task with the given name.

Instance Attribute Summary

#external rw

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

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

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

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

Name of the main, top level task.
#options rw

Additional list of options to be passed rdoc.
#rdoc_dir rw

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

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

Name of template to be used by rdoc.
#title rw

Title of RDoc documentation.
#inline_source rw Internal use only

All source is inline now.
#inline_source=(value) rw Internal use only

All source is inline now.

Instance Method Summary

#before_running_rdoc(&block)

The block passed to this method will be called just before running the RDoc generator.
#check_names(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_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 private
#coverage_task_name private
#rdoc_target private
#rdoc_task_name private
#rerdoc_task_name private

Constructor Details

.new(name = :rdoc) {|_self| ... } ⇒ `Task`

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

Yields:

(_self)

Yield Parameters:

_self (Task) —

the object that the method was called on

[ GitHub ]

# File 'lib/rdoc/task.rb', line 157


def initialize name = :rdoc # :yield: self
  defaults

  check_names name

  @name = name

  yield self if block_given?

  define
end

Instance Attribute Details

#external (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 151


attr_accessor :external

#generator (rw)

Name of format generator (--format) used by rdoc. (defaults to rdoc’s default)

[ GitHub ]

# File 'lib/rdoc/task.rb', line 136


attr_accessor :generator

#inline_source (rw)

This method is for internal use only.

All source is inline now. This method is deprecated

[ GitHub ]

# File 'lib/rdoc/task.rb', line 208


def inline_source # :nodoc:
  warn "RDoc::Task#inline_source is deprecated"
  true
end

#inline_source=(value) (rw)

This method is for internal use only.

All source is inline now. This method is deprecated

[ GitHub ]

# File 'lib/rdoc/task.rb', line 216


def inline_source=(value) # :nodoc:
  warn "RDoc::Task#inline_source is deprecated"
end

#main (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 125


attr_accessor :main

#markup (rw)

The markup format; one of: rdoc (the default), markdown, rd, tomdoc. See {RDoc::Markup Formats}.

[ GitHub ]

# File 'lib/rdoc/task.rb', line 109


attr_accessor :markup

#name (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 104


attr_accessor :name

#options (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 146


attr_accessor :options

#rdoc_dir (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 114


attr_accessor :rdoc_dir

#rdoc_files (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 141


attr_accessor :rdoc_files

#template (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 130


attr_accessor :template

#title (rw)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 119


attr_accessor :title

Instance Method Details

#before_running_rdoc(&block)

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

[ GitHub ]

# File 'lib/rdoc/task.rb', line 287


def before_running_rdoc(&block)
  @before_running_rdoc = block
end

#check_names(names)

Ensures that names only includes names for the :rdoc, :clobber_rdoc and :rerdoc. If other names are given an ArgumentError is raised.

[ GitHub ]

# File 'lib/rdoc/task.rb', line 173


def check_names names
  return unless Hash === names

  invalid_options =
    names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]

  unless invalid_options.empty? then
    raise ArgumentError, "invalid options: #{invalid_options.join ', '}"
  end
end

#clobber_task_description

Task description for the clobber rdoc task or its renamed equivalent

[ GitHub ]

# File 'lib/rdoc/task.rb', line 187


def clobber_task_description
  "Remove RDoc HTML files"
end

#clobber_task_name (private)

[ GitHub ]

# File 'lib/rdoc/task.rb', line 325


def clobber_task_name
  case name
  when Hash then (name[:clobber_rdoc] || "clobber_rdoc").to_s
  else           "clobber_#{name}"
  end
end

#coverage_task_description

Task description for the coverage task or its renamed description

[ GitHub ]

# File 'lib/rdoc/task.rb', line 308


def coverage_task_description
  "Print RDoc coverage report"
end

#coverage_task_name (private)

[ GitHub ]

# File 'lib/rdoc/task.rb', line 339


def coverage_task_name
  "coverage"
end

#defaults

Sets default task values

[ GitHub ]

# File 'lib/rdoc/task.rb', line 194


def defaults
  @name = :rdoc
  @rdoc_files = Rake::FileList.new
  @rdoc_dir = 'html'
  @main = nil
  @title = nil
  @template = nil
  @generator = nil
  @options = []
end

#define

Create the tasks defined by this task lib.

[ GitHub ]

# File 'lib/rdoc/task.rb', line 223


def define
  desc rdoc_task_description
  task rdoc_task_name

  desc rerdoc_task_description
  task rerdoc_task_name => [clobber_task_name, rdoc_task_name]

  desc clobber_task_description
  task clobber_task_name do
    rm_r @rdoc_dir rescue nil
  end

  task :clobber => [clobber_task_name]

  directory @rdoc_dir

  rdoc_target_deps = [
    @rdoc_files,
    Rake.application.rakefile
  ].flatten.compact

  task rdoc_task_name => [rdoc_target]
  file rdoc_target => rdoc_target_deps do
    @before_running_rdoc.call if @before_running_rdoc
    args = option_list + @rdoc_files

    $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
    RDoc::RDoc.new.document args
  end

  namespace rdoc_task_name do
    desc coverage_task_description
    task coverage_task_name do
      @before_running_rdoc.call if @before_running_rdoc
      opts = option_list << "-C"
      args = opts + @rdoc_files

      $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
      RDoc::RDoc.new.document args
    end
  end

  self
end

#option_list

List of options that will be supplied to RDoc

[ GitHub ]

# File 'lib/rdoc/task.rb', line 271


def option_list
  result = @options.dup
  result << "-o"       << @rdoc_dir
  result << "--main"   << main      if main
  result << "--markup" << markup    if markup
  result << "--title"  << title     if title
  result << "-T"       << template  if template
  result << '-f'       << generator if generator
  result
end

#rdoc_target (private)

[ GitHub ]

# File 'lib/rdoc/task.rb', line 314


def rdoc_target
  "#{rdoc_dir}/created.rid"
end

#rdoc_task_description

Task description for the rdoc task or its renamed equivalent

[ GitHub ]

# File 'lib/rdoc/task.rb', line 294


def rdoc_task_description
  'Build RDoc HTML files'
end

#rdoc_task_name (private)

[ GitHub ]

# File 'lib/rdoc/task.rb', line 318


def rdoc_task_name
  case name
  when Hash then (name[:rdoc] || "rdoc").to_s
  else           name.to_s
  end
end

#rerdoc_task_description

Task description for the rerdoc task or its renamed description

[ GitHub ]

# File 'lib/rdoc/task.rb', line 301


def rerdoc_task_description
  "Rebuild RDoc HTML files"
end

#rerdoc_task_name (private)

[ GitHub ]

# File 'lib/rdoc/task.rb', line 332


def rerdoc_task_name
  case name
  when Hash then (name[:rerdoc] || "rerdoc").to_s
  else           "re#{name}"
  end
end

Class: RDoc::Task

Overview

Specifying different task names

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name = :rdoc) {|_self| ... } ⇒ Task

Instance Attribute Details

#external (rw)

#generator (rw)

#inline_source (rw)

#inline_source=(value) (rw)

#main (rw)

#markup (rw)

#name (rw)

#options (rw)

#rdoc_dir (rw)

#rdoc_files (rw)

#template (rw)

#title (rw)

Instance Method Details

#before_running_rdoc(&block)

#check_names(names)

#clobber_task_description

#clobber_task_name (private)

#coverage_task_description

#coverage_task_name (private)

#defaults

#define

#option_list

#rdoc_target (private)

#rdoc_task_description

#rdoc_task_name (private)

#rerdoc_task_description

#rerdoc_task_name (private)

.new(name = :rdoc) {|_self| ... } ⇒ `Task`