Class: Dokkit::TaskLib::Clean

Inherits:
Base
  • Object
show all
Defined in:
lib/dokkit/tasklib/clean.rb

Overview

The Clean task library is a collection of rake tasks devoted to the cleaning of the documentation environment. The library defines a clean:output that remove the generated output folder (if exists). It defines also a clean:cache task that remove the cache folder (if exists).

Instance Attribute Summary collapse

Attributes inherited from Base

#logger, #ns

Instance Method Summary collapse

Constructor Details

#initialize(ns = 'clean') {|_self| ... } ⇒ Clean

Initialize the library with the logger instance, an optional namespace and configuration hash.

Yields:

  • (_self)

Yield Parameters:



24
25
26
27
28
29
30
 
# File 'lib/dokkit/tasklib/clean.rb', line 24

def initialize(ns = 'clean')
  super
  
  yield self if block_given?

  define_tasks
end

Instance Attribute Details

#cache_dir ⇒ Object

Returns the value of attribute cache_dir.



20
21
22
 
# File 'lib/dokkit/tasklib/clean.rb', line 20

def cache_dir
  @cache_dir
end

#output_dir ⇒ Object

Returns the value of attribute output_dir.



20
21
22
 
# File 'lib/dokkit/tasklib/clean.rb', line 20

def output_dir
  @output_dir
end