From 10bb792d867f7f80560de874b4a681636b99de6e Mon Sep 17 00:00:00 2001 From: mpv Date: Tue, 27 Jan 2015 16:45:00 +0300 Subject: [PATCH] Added the Validators doxygen group --- doc/Modules.doc | 13 +++++++++++++ doc/general_architecture.doc | 4 ++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/doc/Modules.doc b/doc/Modules.doc index c507c4e5c..91d2026f7 100644 --- a/doc/Modules.doc +++ b/doc/Modules.doc @@ -33,3 +33,16 @@ * PartSetPlugin, ConstructionPlugin, SketchPlugin, FeaturesPlugins, etc. * */ + +/** + * \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). + * + */ diff --git a/doc/general_architecture.doc b/doc/general_architecture.doc index d6572c405..b7eaec9d6 100644 --- a/doc/general_architecture.doc +++ b/doc/general_architecture.doc @@ -9,9 +9,9 @@ When used outside SALOME, New GEOM must be hosted by an application window imple \n It is proposed that this application window can host several so-called Modules. Below, this main application window is named the Workshop. \n\n -Each Module hosted by the Workshop deals with one type of document only, saved in a format supported by the Module. One document type per Module. Also, in a Workshop window, only one document of a given type can be newed. So, when launching the Workshop, the user selects a type of document to be created. Then, from the application session, creating a new document will launch a new instance of the Workshop. +Each Module hosted by the Workshop deals with one type of document (ModelAPI_Document) only, saved in a format supported by the Module. One document type per Module. Also, in a Workshop window, only one document of a given type can be newed. So, when launching the Workshop, the user selects a type of document to be created. Then, from the application session, creating a new document will launch a new instance of the Workshop. \n\n -The geometric model (i.e. the whole geometry produce by New GEOM) is created through operations, or features, which define a meaningful piece of design (e.g. NewPart, Extrusion, Revolution, Cut, Transformation). In order to easily create dedicated variants of the modeler, also to gradually develop New GEOM, each feature is implemented as a Plug-in (A Plug-in is a piece of application including its own GUI, built separately from the application. It is loaded dynamically to the application). In other words, a Module is made of a collection of Plug-in. +The geometric model (i.e. the whole geometry produce by New GEOM) is created through operations, or features (ModelAPI_Feature), which define a meaningful piece of design (e.g. PartSetPlugin_Part, FeaturesPlugin_Extrusion, FeaturesPlugin_Placement, etc.). In order to easily create dedicated variants of the modeler, also to gradually develop New GEOM, each feature is implemented in a Plug-in (ModelAPI_Plugin, a piece of application including its own GUI, built separately from the application. It is loaded dynamically to the application). In other words, a Module is made of a collection of Plug-ins. \n\n The Workshop structures the features by related functionality presented in a tabbed interface. Each tab displays a set of available actions. These sets of features are called below Workbenches. \n\n -- 2.39.2