Class: Buildr::Doc::Base

Inherits:
Object show all
Defined in:
lib/buildr/core/doc.rb

Overview

Base class for any documentation provider. Defines most common functionality (things like @into@, @from@ and friends).

Direct Known Subclasses

Groovydoc, Javadoc, Scaladoc, VScaladoc

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(project) ⇒ Base

Returns a new instance of Base.



57
58
59
 
# File 'lib/buildr/core/doc.rb', line 57

def initialize(project)
  @project = project
end

Class Attribute Details

.language ⇒ Object

Returns the value of attribute language.



43
44
45
 
# File 'lib/buildr/core/doc.rb', line 43

def language
  @language
end

.source_ext ⇒ Object

Returns the value of attribute source_ext.



43
44
45
 
# File 'lib/buildr/core/doc.rb', line 43

def source_ext
  @source_ext
end

Instance Attribute Details

#project ⇒ Object (readonly)

Returns the value of attribute project.



55
56
57
 
# File 'lib/buildr/core/doc.rb', line 55

def project
  @project
end

Class Method Details

.specify(options) ⇒ Object 



45
46
47
48
 
# File 'lib/buildr/core/doc.rb', line 45

def specify(options)
  @language = options[:language]
  @source_ext = options[:source_ext]
end

.to_sym ⇒ Object 



50
51
52
 
# File 'lib/buildr/core/doc.rb', line 50

def to_sym
  @symbol ||= name.split('::').last.downcase.to_sym
end