module SDL::Util::Documentation

Public Class Methods

included(base) click to toggle source
# File lib/sdl/util/documentation.rb, line 35
def self.included(base)
  base.extend(self)
end
walk_the_class_name(klass) click to toggle source
# 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

Public Instance Methods

documentation() click to toggle source
# 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