Class: ActiveDoc::Rake::Task

Inherits:
Object
  • Object
show all
Defined in:
lib/active_doc/rake/task.rb

Overview

Defines a Rake tasks for generating RDoc documentation from active_doc. User proc to load files you want to generate RDoc for.

The simplest use of it goes something like:

ActiveDoc::Rake::Task.new do
  require 'file_one.rb' # files you want to describe
  require 'file_two.rb'
end

This will define a task named active_doc described as ‘Generate ActiveDoc RDoc documentation’.

Defined Under Namespace

Classes: GenerateRDocRunner

Instance Method Summary collapse

Constructor Details

#initialize(task_name = "active_doc", desc = "Generate ActiveDoc RDoc documentation") {|_self| ... } ⇒ Task

Returns a new instance of Task.

Yields:

  • (_self)

Yield Parameters:



30
31
32
33
34
 
# File 'lib/active_doc/rake/task.rb', line 30

def initialize(task_name = "active_doc", desc = "Generate ActiveDoc RDoc documentation")
  @task_name, @desc = task_name, desc
  yield self if block_given?
  define_task
end

Instance Method Details

#define_task ⇒ Object

:nodoc:



36
37
38
39
40
41
 
# File 'lib/active_doc/rake/task.rb', line 36

def define_task #:nodoc:
  desc @desc
  task @task_name do
    runner.run
  end
end

#runner ⇒ Object

:nodoc:



43
44
45
 
# File 'lib/active_doc/rake/task.rb', line 43

def runner #:nodoc:
  GenerateRDocRunner.new
end