Class: JsdocHelper::Rake::Task

Inherits:

Object

• Object
• JsdocHelper::Rake::Task

Extended by:

Forwardable

Defined in:

lib/jsdoc_helper/rake/task.rb,
lib/jsdoc_helper/rake/task/runner.rb

Overview

Encapsulates rake tasks for generating jsdoc documentation

example:

JsdocHelper::Rake::Task.new do |t|
  t[:toolkit] = '/usr/local/lib/jsdoc-toolkit'
  t[:files] << 'ext'
  t[:template] = 'templates/jsdoc_custom'
  t[:out] = 'html'
  t[:options] = '--private'
end

Defined Under Namespace

Classes: Runner

Constant Summary

DEFAULT_NAME =

'jsdoc'

Instance Method Summary

• #initialize(task_name = DEFAULT_NAME) {|_self| ... } ⇒ Task constructor

  Create a new jsdoc-toolkit task.

Constructor Details

#initialize(task_name = DEFAULT_NAME) {|_self| ... } ⇒ Task

Create a new jsdoc-toolkit task. If a block is passed, the task object will be passed as an argument to the block.

Yields:

• (_self)

Yield Parameters:

• _self (JsdocHelper::Rake::Task) —

  the object that the method was called on

# File 'lib/jsdoc_helper/rake/task.rb', line 23

def initialize(task_name=DEFAULT_NAME)
  yield self if block_given?
  define_task(task_name)
end