X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2FModules.doc;h=71060e595a7be054a67c4a1d413bdfe22c8a02b1;hb=283433d9c2f39fbd332d6eba691b6a0cd875e29d;hp=c507c4e5cdb0061a298316bb34651cf2c13e6bb2;hpb=a0bf1eb5af40ce92ee7e682959bf5738a3fc092b;p=modules%2Fshaper.git diff --git a/doc/Modules.doc b/doc/Modules.doc index c507c4e5c..71060e595 100644 --- a/doc/Modules.doc +++ b/doc/Modules.doc @@ -20,6 +20,7 @@ * The geometrical algorithms implementation (basing on OCCT libraries) are located in GeomAlgoAPI. * */ + /** * \defgroup Plugins Plugins @@ -28,8 +29,62 @@ * * The C++ and Python features implementations are located in plugins: specially organized libraries * and configuration files that allows to define the user interface and specific algorithms. - * There are many plugins that should be extended wit hthe development of the application. The names + * There are many plugins that should be extended with the development of the application. The names * of plugin-packages are ended with "Plugin" string: * PartSetPlugin, ConstructionPlugin, SketchPlugin, FeaturesPlugins, etc. * */ + + /** + * \defgroup Config Config + * + * \brief XML processing tools used in the application + * + * The tools for reading definitions of plugins, features and widgets. + * + */ + +/** + * \defgroup GUI GUI of the application + * + * \brief Classes for graphic user interface definition + * + * Classes of application windows definition, operations launching, + * and objects presentations. It consists of two packages: + * - ModuleBase - level for modules definition + * - XGUI - implementation of Application GUI. + */ + +/** + * \defgroup Salome A Salome connector + * + * \brief A set of classes which provide wrapping of + * OpenParts application as SALOME module + */ + +/** + * \defgroup Desktop Classes for standalone application + * + * \brief This group contains classes for launching the application + * in standalone desktop (without SALOME) + */ + +/** + * \defgroup Modules Modules + * + * \brief Definition of a module as a set of classes for plugins management + */ + +/** + * \defgroup Validators Validators + * + * \brief Implementation of internal logic of the feature + * + * Validators are used for checking validity of the feature: each argument, + * dependencies between the arguments. Validators are defined in the + * configuration files and may be also used for selection filters (ModuleBase_SelectionValidator), + * passing configurable parameters from XML file to the feature implementation + * (like in ExchangePlugin_ImportFormatValidator). + * + */ +