Class: Tailmix::Dev::Docs

Inherits:
Object
  • Object
show all
Defined in:
lib/tailmix/dev/docs.rb

Instance Method Summary collapse

Constructor Details

#initialize(tools) ⇒ Docs

Returns a new instance of Docs.



7
8
9
10
11
 
# File 'lib/tailmix/dev/docs.rb', line 7

def initialize(tools)
  @tools = tools
  @definition = tools.definition
  @component_class_name = tools.component_class
end

Instance Method Details

#generate ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/tailmix/dev/docs.rb', line 13

def generate
  output = ["== Tailmix Docs for #{@component_class_name} =="]

  signature = generate_signature
  output << "Signature: `initialize(#{signature})`" unless signature.empty?
  output << ""

  output << generate_dimensions_docs
  output << generate_compound_variants_docs
  output << generate_actions_docs

  output.join("\n")
end