Class: PDoc::Generators::AbstractGenerator

Inherits:

Object

• Object
• PDoc::Generators::AbstractGenerator

Defined in:

lib/pdoc/generators/abstract_generator.rb

Direct Known Subclasses

Html::Website, JSON, Pythonesque

Instance Attribute Summary

• #options ⇒ Object readonly

  Returns the value of attribute options.

• #root ⇒ Object readonly

  Returns the value of attribute root.

Instance Method Summary

• #initialize(root, options = {}) ⇒ AbstractGenerator constructor

  A new instance of AbstractGenerator.

• #mkdir(name) ⇒ Object

  Creates a new directory with read, write and execute permission.

Constructor Details

#initialize(root, options = {}) ⇒ AbstractGenerator

Returns a new instance of AbstractGenerator.

# File 'lib/pdoc/generators/abstract_generator.rb', line 5

def initialize(root, options = {})
  @root = root
  @options = options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.

# File 'lib/pdoc/generators/abstract_generator.rb', line 4

def options
  @options
end

#root ⇒ Object (readonly)

Returns the value of attribute root.

# File 'lib/pdoc/generators/abstract_generator.rb', line 4

def root
  @root
end

Instance Method Details

#mkdir(name) ⇒ Object

Creates a new directory with read, write and execute permission.

# File 'lib/pdoc/generators/abstract_generator.rb', line 11

def mkdir(name)
  Dir.mkdir(name, 0755)
end