Class: Doc::Configurator

Inherits:
Object
  • Object
show all
Defined in:
lib/doc/configurator.rb,
lib/doc/configurator/gems.rb,
lib/doc/configurator/ruby.rb,
lib/doc/configurator/paths.rb,
lib/doc/configurator/rails.rb,
lib/doc/configurator/ruby/source.rb,
lib/doc/configurator/ruby/stdlib.rb,
lib/doc/configurator/ruby/path_info.rb,
lib/doc/configurator/ruby/version_specifier.rb

Direct Known Subclasses

Gems, Paths, Rails, Ruby

Defined Under Namespace

Classes: Gems, Paths, Rails, Ruby

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(documentor, *arguments, &block) ⇒ Configurator

Returns a new instance of Configurator.



15
16
17
18
 
# File 'lib/doc/configurator.rb', line 15

def initialize(documentor, *arguments, &block)
  @documentor = documentor
  @config = ConfigObject.new(self.class.default_config_key, *arguments, &block)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



14
15
16
 
# File 'lib/doc/configurator.rb', line 14

def config
  @config
end

#documentor ⇒ Object (readonly)

Returns the value of attribute documentor.



14
15
16
 
# File 'lib/doc/configurator.rb', line 14

def documentor
  @documentor
end

Class Method Details

.default_config_key(value = nil) ⇒ Object 



8
9
10
11
 
# File 'lib/doc/configurator.rb', line 8

def default_config_key(value = nil)
  @default_config_key = value.to_sym if value
  @default_config_key || :default
end

.inherited(subclass) ⇒ Object 



4
5
6
 
# File 'lib/doc/configurator.rb', line 4

def inherited(subclass)
  RootConfig.configurator subclass.name.underscore.split('/').last, subclass
end