doc/Modules.doc

   1 // Special file to define and describe the modules (goups)
   2
   3 /**
   4  * \defgroup DataModel Data model
   5  *
   6  * \brief Structures for storage and management the application data.
   7  *
   8  * Data structures are unified and splitted in universal <b>ModelAPI</b> package.
   9  * The OCCT specialized implementation of ModelAPI interfaces is located in the <b>Model</b>.
  10  * The geometrical primitives interfaces in <b>GeomAPI</b> package are supported by geometrical
  11  * persistence elements in <b>GeomDatAPI</b> interface and has OCCT-specific implementation in GeomData package.
  12  *
  13  */
  14
  15 /**
  16  * \defgroup DataAlgo Algorithms
  17  *
  18  * \brief Different algorithm used in the application
  19  *
  20  * The geometrical algorithms implementation (basing on OCCT libraries) are located in <b>GeomAlgoAPI</b>.
  21  *
  22  */
  23
  24 /**
  25  * \defgroup Plugins Plugins
  26  *
  27  * \brief Implementation of specific features of the application is concentrated in plugins.
  28  *
  29  * The C++ and Python features implementations are located in plugins: specially organized libraries
  30  * and configuration files that allows to define the user interface and specific algorithms.
  31  * There are many plugins that should be extended with the development of the application. The names
  32  * of plugin-packages are ended with "Plugin" string:
  33  * <b>PartSetPlugin</b>, <b>ConstructionPlugin</b>, <b>SketchPlugin</b>, <b>FeaturesPlugins</b>, etc.
  34  *
  35  */
  36
  37 /**
  38  * \defgroup GUI GUI of the application
  39  *
  40  * \brief Classes for griphic user interface definition
  41  *
  42  * Classes of application windows definition, operations launching,
  43  * and objects presentations. It consists of two packages:
  44  * - ModuleBase - level for modules definition
  45  * - XGUI - implementation of Application GUI.
  46  */
  47
  48 /**
  49  * \defgroup Salome A Salome connector
  50  *
  51  * \brief A set of classes which provide wrapping of
  52  * OpenParts application as SALOME module
  53  */
  54
  55 /**
  56  * \defgroup Desktop Classes for standalone application
  57  *
  58  * \brief This group contains classes for launching the application
  59  * in standalone desktop (without SALOME)
  60  */
  61
  62 /**
  63  * \defgroup Modules Modules
  64  *
  65  * \brief Definition of a module as a set of classes for plugins management
  66  */