Module: SDL::Util::Documentation

Defined in:
lib/sdl/util/documentation.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



35
36
37
 
# File 'lib/sdl/util/documentation.rb', line 35

def self.included(base)
  base.extend(self)
end

.walk_the_class_name(klass) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/sdl/util/documentation.rb', line 51

def self.walk_the_class_name(klass)
  klass_key = klass.local_name.underscore.downcase

  if klass.superclass.eql?(SDL::Base::Type)
    klass_key = "#{klass.superclass.local_name.underscore.downcase}.#{klass_key}"
  else
    klass_key = "#{walk_the_class_name(klass.superclass)}_#{klass_key}"
  end

  klass_key
end

Instance Method Details

#documentation ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/sdl/util/documentation.rb', line 39

def documentation
  if self.respond_to?(:documentation_key)
    documentation = I18n.t(documentation_key)

    if documentation =~ /#\{.*\}/
      eval '"' + I18n.t(documentation_key) + '"', binding
    else
      documentation
    end
  end
end