kross/Mainpage.dox

   1 /** @mainpage Kross - a Scripting Framework for Applications
   2
   3 %Kross is a scripting bridge to embed scripting functionality
   4 into an application. %Kross provides an abstract API to provide
   5 scripting functionality in a interpreter-independent
   6 way. The application that uses %Kross should not need to know
   7 anything about the scripting language being used.
   8
   9 <!--
  10 The referenced anchors (core, modules etc) should probably
  11 refer to pages (see eg: Mainpage.dox in the parent directory).
  12
  13 If you have content for these sections and want
  14 help writing the doxygen bits for them, get in touch with me:
  15 Alex Merry <kde@randomguy3.me.uk>
  16
  17 If there is no more to put, then remove the @ref, the following
  18 word (eg: core) and the quotation marks.  Also, putting % before
  19 each occurrent of Kross will prevent Doxygen linking it to the
  20 Kross namespace.  So the first line will end up as:
  21 - The core of %Kross
  22
  23 Then you can get rid of this comment as well.
  24 -->
  25
  26 The main parts of %Kross:
  27 - @ref core "The core of Kross"
  28 - @ref modules "The optional Kross modules"
  29 - @ref console "The Kross console application"
  30 - @ref test "The unit- and regression tests"
  31
  32 The interpreter backends supported by %Kross:
  33 - @ref python "The Python interpreter backend"
  34 - @ref ruby "The Ruby interpreter backend"
  35 - @ref kjs "The KDE JavaScript interpreter backend"
  36
  37 Links:
  38 - <a href="http://kross.dipe.org">Kross website</a>
  39 - <a href="http://techbase.kde.org/Development/Tutorials/Kross-Tutorial">Kross tutorial on TechBase</a>
  40 - <a href="http://www.kexi-project.org/wiki/wikiview/index.php?Scripting">Scripting in Kexi</a>
  41 - <a href="http://www.koffice.org">KOffice website</a>
  42
  43 @authors
  44 Sebastian Sauer \<mail AT dipe DOT %org\><br>
  45 Cyrille Berger \<cberger AT cberger DOT net\>
  46
  47 @maintainers
  48 [Unknown/None]
  49
  50 @licenses
  51 @lgpl
  52
  53 */
  54
  55 // DOXYGEN_REFERENCES = kdecore kdeui
  56 // DOXYGEN_SET_PROJECT_NAME = Kross
  57 // vim:ts=4:sw=4:expandtab:filetype=doxygen