Class: RDoc::Task

Inherits:
Rake::TaskLib
  • Object
show all
Defined in:
lib/rdoc/task.rb

Overview

RDoc::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 RDoc::Task object. See the attributes list for the RDoc::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.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 and :rdoc:force.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

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

Yields:

  • (_self)

Yield Parameters:

  • _self (RDoc::Task)

    the object that the method was called on


155
156
157
158
159
160
161
162
163
164
165
# File 'lib/rdoc/task.rb', line 155

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

  check_names name

  @name = name

  yield self if block_given?

  define
end

Instance Attribute Details

#externalObject

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


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

def external
  @external
end

#generatorObject

Name of format generator (<tt>–format<tt>) used by rdoc. (defaults to rdoc's default)


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

def generator
  @generator
end

#mainObject

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


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

def main
  @main
end

#markupObject

Comment markup format. rdoc, rd and tomdoc are supported. (default is 'rdoc')


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

def markup
  @markup
end

#nameObject

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


101
102
103
# File 'lib/rdoc/task.rb', line 101

def name
  @name
end

#optionsObject

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


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

def options
  @options
end

#rdoc_dirObject

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


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

def rdoc_dir
  @rdoc_dir
end

#rdoc_filesObject

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


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

def rdoc_files
  @rdoc_files
end

#templateObject

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


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

def template
  @template
end

#titleObject

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


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

def title
  @title
end

Instance Method Details

#before_running_rdoc(&block) ⇒ Object

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


273
274
275
# File 'lib/rdoc/task.rb', line 273

def before_running_rdoc(&block)
  @before_running_rdoc = block
end

#check_names(names) ⇒ Object

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


171
172
173
174
175
176
177
178
179
180
# File 'lib/rdoc/task.rb', line 171

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_descriptionObject

Task description for the clobber rdoc task or its renamed equivalent


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

def clobber_task_description
  "Remove RDoc HTML files"
end

#defaultsObject

Sets default task values


192
193
194
195
196
197
198
199
200
201
# File 'lib/rdoc/task.rb', line 192

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

#defineObject

Create the tasks defined by this task lib.


221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/rdoc/task.rb', line 221

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

  self
end

#inline_sourceObject

All source is inline now. This method is deprecated


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

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

#inline_source=(value) ⇒ Object

All source is inline now. This method is deprecated


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

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

#option_listObject

List of options that will be supplied to RDoc


257
258
259
260
261
262
263
264
265
266
# File 'lib/rdoc/task.rb', line 257

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_task_descriptionObject

Task description for the rdoc task or its renamed equivalent


280
281
282
# File 'lib/rdoc/task.rb', line 280

def rdoc_task_description
  'Build RDoc HTML files'
end

#rerdoc_task_descriptionObject

Task description for the rerdoc task or its renamed description


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

def rerdoc_task_description
  "Rebuild RDoc HTML files"
end