kig/scripting/python-scripting-api-dox-mainpage.h

   1 /** \mainpage Kig Python Scripting API Documentation
   2  * \section Introduction
   3  * This is the documentation of the Kig Python Scripting API.  It is
   4  * intended as a reference for people using the Kig Python Scripting
   5  * System.  The Documentation is generated from the C++ sources for
   6  * the classes, and unfortunately, this means that the documentation
   7  * uses a C++ syntax.  However, if you ignore this fact, and simply
   8  * look at the API as a set of classes with member and static
   9  * functions, then you should be fine.
  10  *
  11  * \section The API
  12  * This API is mostly meant to be used from user-defined calc()
  13  * functions.  In these functions, it is necessary to
  14  * \li access the information of the argument \ref ObjectImp's
  15  * \li construct and return a new ObjectImp
  16  *
  17  * Both uses require the ObjectImp API to be exported to Python, and
  18  * this is the major part of this API.  Some more classes are also
  19  * exported, but mostly because they are used from one of the
  20  * ObjectImp's APIs.
  21  *
  22  * \section Links
  23  *
  24  * Next suggested reading is the
  25  * \ref ObjectImp "documentation of the ObjectImp class".
  26  */