ruby/krossruby/ruby.dox

   1 /** @section ruby The Ruby interpreter backend
   2  *
   3  * The Ruby interpreter backend implements scripting with Ruby.
   4  *
   5  * The @a Kross::RubyInterpreter class implements @a Kross::Interpreter
   6  * for the Ruby interpreter backend and provides with the
   7  * @a Kross::RubyInterpreter::createScript a factory method to create
   8  * @a Kross::RubyScript instances.
   9  *
  10  * The @a Kross::RubyScript class implements @a Kross::Script for the
  11  * Ruby backend to provide the functionality to execute Ruby code
  12  * within a script-container.
  13  *
  14  * The @a Kross::RubyModule class is the __main__ Ruby environment used
  15  * as global object namespace. This module is shared between the different
  16  * @a Kross::RubyScript instances which run in there own module namespace.
  17  * The @a Kross::RubyModule also spends access to the the whole Kross
  18  * functionality and manages all the @a Kross::RubyExtension modules.
  19  *
  20  * The @a Kross::RubyExtension class implements a Ruby VALUE object to wrap a
  21  * QObject instance into the world of Ruby.
  22  *
  23  * Within RubyVariant the @a Kross::RubyType helper class is used to cast
  24  * between QVariant and Ruby VALUE values while the @a Kross::RubyMetaTypeFactory
  25  * helper class is used as factory within @a Kross::RubyExtension to translate
  26  * an argument into a @a Kross::MetaType needed for QGenericArgument's data pointer.
  27  */