class Object

Public Instance Methods

init() click to toggle source

Define where state machine descriptions will be rendered

Calls superclass method
  # File lib/state_machine/yard/templates/default/class/html/setup.rb
4 def init
5   super
6   sections.place(:state_machine_details).before(:children)
7 end
state_machine_details() click to toggle source

Renders state machine details in the main content of the class’s documentation

   # File lib/state_machine/yard/templates/default/class/html/setup.rb
10 def state_machine_details
11   erb(:state_machines) if state_machines
12 end
state_machine_image_path(machine) click to toggle source

Generates the image path for the given machine’s visualization

   # File lib/state_machine/yard/templates/default/class/html/setup.rb
26 def state_machine_image_path(machine)
27   base_path = File.dirname(serializer.serialized_path(object))
28   image_name = "#{object.name}_#{machine[:name]}"
29   "#{File.join(base_path, image_name)}.png"
30 end
state_machines() click to toggle source

Gets a list of state machines prased for this class

   # File lib/state_machine/yard/templates/default/class/html/setup.rb
15 def state_machines
16   @state_machines ||= begin
17     if state_machines = object['state_machines']
18       state_machines.each do |name, machine|
19         serializer.serialize(state_machine_image_path(machine), machine[:image]) if machine[:image]
20       end
21     end
22   end
23 end