Class: JsDocToolkit::DocTask

Inherits:

Object

• Object
• JsDocToolkit::DocTask

Defined in:

lib/jsdoc-toolkit/doc_task.rb

Instance Attribute Summary

• #jsdoc_files ⇒ Object readonly

  Returns the value of attribute jsdoc_files.

Instance Method Summary

• #initialize(task_name) {|_self| ... } ⇒ DocTask constructor

  A new instance of DocTask.

• #jsdoc_dir=(path) ⇒ Object

Constructor Details

#initialize(task_name) {|_self| ... } ⇒ DocTask

Returns a new instance of DocTask.

Yields:

• (_self)

Yield Parameters:

• _self (JsDocToolkit::DocTask) —

  the object that the method was called on

# File 'lib/jsdoc-toolkit/doc_task.rb', line 10

def initialize(task_name)
  @jsdoc_files = []
  yield(self)
  task(task_name) { build }
end

Instance Attribute Details

#jsdoc_files ⇒ Object (readonly)

Returns the value of attribute jsdoc_files.

# File 'lib/jsdoc-toolkit/doc_task.rb', line 8

def jsdoc_files
  @jsdoc_files
end

Instance Method Details

#jsdoc_dir=(path) ⇒ Object

# File 'lib/jsdoc-toolkit/doc_task.rb', line 16

def jsdoc_dir=(path)    
  @jsdoc_dir = Pathname(path)
end