Class: RDoc::Task
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Rake::TaskLib
|
|
Instance Chain:
self,
Rake::TaskLib
|
|
Inherits: |
Rake::TaskLib
|
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.
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.doc"
rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
rdoc. << "--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
and :rdoc:force
.
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 (<tt>–format<tt>) used by rdoc.
-
#main
rw
Name of file to be used as the main, top level file of the RDoc.
-
#markup
rw
Comment markup format.
-
#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.
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. -
#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
- #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.
Instance Attribute Details
#external (rw)
Whether to run the rdoc process as an external shell (default is false)
# File 'lib/rdoc/task.rb', line 150
attr_accessor :external
#generator (rw)
Name of format generator (<tt>–format<tt>) used by rdoc. (defaults to rdoc's default)
# File 'lib/rdoc/task.rb', line 135
attr_accessor :generator
#main (rw)
Name of file to be used as the main, top level file of the RDoc. (default is none)
# File 'lib/rdoc/task.rb', line 124
attr_accessor :main
#markup (rw)
Comment markup format. rdoc, rd and tomdoc are supported. (default is 'rdoc')
# File 'lib/rdoc/task.rb', line 108
attr_accessor :markup
#name (rw)
Name of the main, top level task. (default is :rdoc
)
# File 'lib/rdoc/task.rb', line 102
attr_accessor :name
#options (rw)
Additional list of options to be passed rdoc. (default is [])
# File 'lib/rdoc/task.rb', line 145
attr_accessor :
#rdoc_dir (rw)
Name of directory to receive the html output files. (default is “html”)
# File 'lib/rdoc/task.rb', line 113
attr_accessor :rdoc_dir
#rdoc_files (rw)
List of files to be included in the rdoc generation. (default is [])
# File 'lib/rdoc/task.rb', line 140
attr_accessor :rdoc_files
#template (rw)
Name of template to be used by rdoc. (defaults to rdoc's default)
# File 'lib/rdoc/task.rb', line 129
attr_accessor :template
#title (rw)
Title of RDoc documentation. (defaults to rdoc's default)
# File 'lib/rdoc/task.rb', line 118
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.
# File 'lib/rdoc/task.rb', line 274
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.
# File 'lib/rdoc/task.rb', line 172
def check_names names return unless Hash === names = names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc] unless .empty? then raise ArgumentError, "invalid options: #{ .join ', '}" end end
#clobber_task_description
Task
description for the clobber rdoc task or its renamed equivalent
# File 'lib/rdoc/task.rb', line 186
def clobber_task_description "Remove RDoc HTML files" end
#clobber_task_name (private)
[ GitHub ]#defaults
Sets default task values
#define
Create the tasks defined by this task lib.
# File 'lib/rdoc/task.rb', line 222
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. .trace RDoc::RDoc.new.document args end self end
#option_list
List of options that will be supplied to RDoc
# File 'lib/rdoc/task.rb', line 258
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 294
def rdoc_target "#{rdoc_dir}/created.rid" end
#rdoc_task_description
Task
description for the rdoc task or its renamed equivalent
# File 'lib/rdoc/task.rb', line 281
def rdoc_task_description 'Build RDoc HTML files' end
#rdoc_task_name (private)
[ GitHub ]#rerdoc_task_description
Task
description for the rerdoc task or its renamed description
# File 'lib/rdoc/task.rb', line 288
def rerdoc_task_description "Rebuild RDoc HTML files" end