From: mpv Date: Tue, 27 Jan 2015 13:05:38 +0000 (+0300) Subject: Make the doxygen documentation more structurized and added a general description... X-Git-Tag: V_1.0.0~17^2~5 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=a0bf1eb5af40ce92ee7e682959bf5738a3fc092b;p=modules%2Fshaper.git Make the doxygen documentation more structurized and added a general description pages --- diff --git a/doc/Modules.doc b/doc/Modules.doc new file mode 100644 index 000000000..c507c4e5c --- /dev/null +++ b/doc/Modules.doc @@ -0,0 +1,35 @@ +// Special file to define and describe the modules (goups) + +/** + * \defgroup DataModel Data model + * + * \brief Structures for storage and management the application data. + * + * Data structures are unified and splitted in universal ModelAPI package. + * The OCCT specialized implementation of ModelAPI interfaces is located in the Model. + * The geometrical primitives interfaces in GeomAPI package are supported by geometrical + * persistence elements in GeomDatAPI interface and has OCCT-specific implementation in GeomData package. + * + */ + +/** + * \defgroup DataAlgo Algorithms + * + * \brief Different algorithm used in the application + * + * The geometrical algorithms implementation (basing on OCCT libraries) are located in GeomAlgoAPI. + * + */ + +/** + * \defgroup Plugins Plugins + * + * \brief Implementation of specific features of the application is concentrated in plugins. + * + * 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 + * of plugin-packages are ended with "Plugin" string: + * PartSetPlugin, ConstructionPlugin, SketchPlugin, FeaturesPlugins, etc. + * + */ diff --git a/doc/doxyfile.in b/doc/doxyfile.in index c44dbe6f0..56cda9b0b 100644 --- a/doc/doxyfile.in +++ b/doc/doxyfile.in @@ -669,7 +669,7 @@ WARN_LOGFILE = log.txt # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @PROJECT_SOURCE_DIR@/src +INPUT = @PROJECT_SOURCE_DIR@/src @CMAKE_CURRENT_SOURCE_DIR@ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -690,7 +690,8 @@ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h \ *.cpp \ *.hxx \ - *.cxx + *.cxx \ + *.doc # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -752,7 +753,7 @@ EXAMPLE_RECURSIVE = NO # directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@ # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program diff --git a/doc/general_architecture.doc b/doc/general_architecture.doc new file mode 100644 index 000000000..d6572c405 --- /dev/null +++ b/doc/general_architecture.doc @@ -0,0 +1,86 @@ +/*! +\page general_architecture General Architecture + +New GEOM is used either as a stand-alone application or as a Module integrated to the SALOME environment in order to, ultimately, replace the old GEOM. + +

Stand-alone New GEOM

+ +When used outside SALOME, New GEOM must be hosted by an application window implementing the general ergonomics of New GEOM (the GUI), including the layout of the user interface, organization of menus, runtime help, etc. +\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. +\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. +\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 +Additionally, a Module can either reference or include other Modules: + + + + +

Application to New GEOM

+ +New GEOM is made of one Module, Set of Parts (a Set of Parts is a flat list of Parts, on the contrary of an Assembly in which the Parts are structured), including two other Modules, Part and Properties. The Set of Parts Module produces a PartSet document which references a list of Parts (one document per Part), the PartSet document being referenced by a Properties document (one document per PartSet). +\n\n +The Set of Parts, its Properties and the Parts it references are all edited from the same Workshop window. The Properties and Part documents cannot be open independently of PartSet (the corresponding Modules being available only as included in Set of Parts). +\n +When creating a new PartSet, a Property document is automatically created. The Workbench of the Set of Parts Module includes a feature for creating a new Part. Once the first Part is created, the Workbenches of Part Module are activated. One Part of the ParSet being always active, the features of Part Module apply to this Part. +\n +When the user saves its session, all documents are saved: the PartSet, its Properties and each Part. +\n\n +\image html general_architecture_1.png +\n + +Summary of the general architecture of New GEOM: + + + + +

New GEOM as SALOME module

+ +The NewGeom package allows to launch the application as one of the module of SALOME platform. In that case all user interface elements are integrated into SALOME platform: the \b NewGeom package is used for this connection. + +Initially the New GEOM application is defined as a Light SALOME module, later it may be changed in order to manage the communication with other SALOME modules correctly. +\n +To integrate New GEOM into SALOME the next steps are done: +
    +
  1. LightApp_Module class from SALOME GUI LightApp package is redefined. This redefined class provides a connection between LightApp_Module interface and Workshop object of the application.
    2. +
  2. Provide Workshop with a module mode of launching in SALOME environment. In this case it is launched without its own main window, 3d viewer and main menu.
    3. +
  3. In module mode workshop uses: +
      +
    1. SALOME desktop as a main window.
      2. +
    2. OCC viewer from SALOME platform instead of its own 3d viewer.
      3. +
    3. SALOME main menu and toolbars for creation of workbenches commands.
      4. +
    4. Object Browser of New GEOM application is used instead of SALOME Object Browser.
      5. +
    5. Creation of a New GEOM property panel as a docking window of SALOME desktop.
      6. +
    6. Use SALOME Python console instead of console in main window. Since 3 packages from SALOME GUI module become shared between this project and SALOME mod-ules and they are independed from other SALOME parts, it is proposed in the future to detach it from SALOME platform into separated prerequisite product to avoid code duplication.
      7. +
    +
    4. +
  4. Each workbench will be defined as a menu in main menu bar of SALOME desktop and as a toolbar with corresponded title.
    5. +
  5. Each feature in the workbench will be defined as a menu item in the corresponded menu and a button in the corresponded toolbar.
    6. +
  6. Object Browser of SALOME is hidden on activation of NewGEOM and restored on its deactivation.
    7. +
  7. Object Browser and Property panel of NewGEOM is shown on activation of the module and hidden on its deactivation.
    8. +
  8. Persistent of NewGEOM is compatible with persistent of SALOME. On saving of SALOME study the content of NewGEOM data structure is saved into study also and restored on restoring of study.
    9. +
+ +*/ diff --git a/doc/general_architecture_1.png b/doc/general_architecture_1.png new file mode 100644 index 000000000..3465128f9 Binary files /dev/null and b/doc/general_architecture_1.png differ diff --git a/doc/index.doc b/doc/index.doc new file mode 100644 index 000000000..e0806cab0 --- /dev/null +++ b/doc/index.doc @@ -0,0 +1,16 @@ +/*! \mainpage + +To browse the New GEOM module Developer Documentation, follow the links below or use navigation menu at the top and left of the page: + + +Also you may see \subpage general_architecture document that describes +the main principles and terms of the development. + +The creation of new feature in C++ or python can be done with help of \subpage first_feature_help . + +*/ diff --git a/src/ConstructionPlugin/ConstructionPlugin_Axis.h b/src/ConstructionPlugin/ConstructionPlugin_Axis.h index 099d547e3..87ab72be5 100644 --- a/src/ConstructionPlugin/ConstructionPlugin_Axis.h +++ b/src/ConstructionPlugin/ConstructionPlugin_Axis.h @@ -22,7 +22,7 @@ const std::string POINT_ATTR_FIRST = "firstPoint"; const std::string POINT_ATTR_SECOND = "secondPoint"; /**\class ConstructionPlugin_Axis - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new axis in PartSet. */ class ConstructionPlugin_Axis : public ModelAPI_Feature, public GeomAPI_ICustomPrs diff --git a/src/ConstructionPlugin/ConstructionPlugin_Plane.h b/src/ConstructionPlugin/ConstructionPlugin_Plane.h index 369f20586..9697654e5 100644 --- a/src/ConstructionPlugin/ConstructionPlugin_Plane.h +++ b/src/ConstructionPlugin/ConstructionPlugin_Plane.h @@ -21,7 +21,7 @@ const std::string FACE_ATTR = "planeFace"; const std::string DISTANCE_ATTR = "distance"; /**\class ConstructionPlugin_Plane - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new planar surface in PartSet. */ class ConstructionPlugin_Plane : public ModelAPI_Feature, public GeomAPI_ICustomPrs diff --git a/src/ConstructionPlugin/ConstructionPlugin_Point.h b/src/ConstructionPlugin/ConstructionPlugin_Point.h index 637b96193..cbab9d1ce 100644 --- a/src/ConstructionPlugin/ConstructionPlugin_Point.h +++ b/src/ConstructionPlugin/ConstructionPlugin_Point.h @@ -21,7 +21,7 @@ const std::string POINT_ATTR_Y = "y"; const std::string POINT_ATTR_Z = "z"; /**\class ConstructionPlugin_Point - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new part in PartSet. */ class ConstructionPlugin_Point : public ModelAPI_Feature diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_BREPImport.h b/src/GeomAlgoAPI/GeomAlgoAPI_BREPImport.h index e8db4b556..aa0c7202d 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_BREPImport.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_BREPImport.h @@ -18,6 +18,7 @@ namespace BREPImport { +/// Implementation of the import BREP files algorithms GEOMALGOAPI_EXPORT TopoDS_Shape Import(const TCollection_AsciiString& theFileName, const TCollection_AsciiString& theFormatName, diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Extrusion.h b/src/GeomAlgoAPI/GeomAlgoAPI_Extrusion.h index 9db662fa2..0ac301469 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Extrusion.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Extrusion.h @@ -13,6 +13,7 @@ #include #include #include + /**\class GeomAlgoAPI_Extrusion * \ingroup DataAlgo * \brief Allows to create the prism based on a given face and a direction diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h index 4082464af..186b12c67 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h @@ -11,7 +11,7 @@ #include /**\class GeomAlgoAPI_MakeShape - * \ingroup DataModel + * \ingroup DataAlgo * \brief Interface to the root class of all topological shapes constructions */ class GeomAlgoAPI_MakeShape : public GeomAPI_Interface diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_STEPImport.h b/src/GeomAlgoAPI/GeomAlgoAPI_STEPImport.h index 6cb5df61c..232f28dce 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_STEPImport.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_STEPImport.h @@ -16,10 +16,13 @@ namespace STEPImport { +/// Implementation of the import parameter from the STEP file GEOMALGOAPI_EXPORT Handle(TCollection_HAsciiString) GetValue(const TCollection_AsciiString& theFileName, const TCollection_AsciiString& theParameterName, TCollection_AsciiString& theError); + +/// Implementation of the import STEP files algorithms GEOMALGOAPI_EXPORT TopoDS_Shape Import(const TCollection_AsciiString& theFileName, const TCollection_AsciiString& theFormatName, TCollection_AsciiString& theError, diff --git a/src/PartSetPlugin/PartSetPlugin_Duplicate.h b/src/PartSetPlugin/PartSetPlugin_Duplicate.h index 8217ed874..5aa92ed1a 100644 --- a/src/PartSetPlugin/PartSetPlugin_Duplicate.h +++ b/src/PartSetPlugin/PartSetPlugin_Duplicate.h @@ -10,7 +10,7 @@ #include "PartSetPlugin_Part.h" /**\class PartSetPlugin_Duplicate - * \ingroup DataModel + * \ingroup Plugins * \brief Duplicates the active part (not root). Creates a new "part" feature. */ class PartSetPlugin_Duplicate : public PartSetPlugin_Part diff --git a/src/PartSetPlugin/PartSetPlugin_Part.h b/src/PartSetPlugin/PartSetPlugin_Part.h index 590d69562..5b7d63e49 100644 --- a/src/PartSetPlugin/PartSetPlugin_Part.h +++ b/src/PartSetPlugin/PartSetPlugin_Part.h @@ -11,7 +11,7 @@ #include /**\class PartSetPlugin_Part - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new part in PartSet. */ class PartSetPlugin_Part : public ModelAPI_Feature diff --git a/src/PartSetPlugin/PartSetPlugin_Remove.h b/src/PartSetPlugin/PartSetPlugin_Remove.h index c29028d39..5f3e35425 100644 --- a/src/PartSetPlugin/PartSetPlugin_Remove.h +++ b/src/PartSetPlugin/PartSetPlugin_Remove.h @@ -11,7 +11,7 @@ #include /**\class PartSetPlugin_Remove - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new part in PartSet. */ class PartSetPlugin_Remove : public ModelAPI_Feature diff --git a/src/SketchPlugin/SketchPlugin_Arc.h b/src/SketchPlugin/SketchPlugin_Arc.h index f24af300f..044d07462 100644 --- a/src/SketchPlugin/SketchPlugin_Arc.h +++ b/src/SketchPlugin/SketchPlugin_Arc.h @@ -13,7 +13,7 @@ #include /**\class SketchPlugin_Arc - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new arc of circle in PartSet. * The visualization of this object is separated in two parts. The first one is an AIS object * calculated when there is non-initialized attributes of the arc. The second is a result and diff --git a/src/SketchPlugin/SketchPlugin_Circle.h b/src/SketchPlugin/SketchPlugin_Circle.h index 76bac7887..f3434d4b5 100644 --- a/src/SketchPlugin/SketchPlugin_Circle.h +++ b/src/SketchPlugin/SketchPlugin_Circle.h @@ -13,7 +13,7 @@ #include /**\class SketchPlugin_Circle - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new circle in PartSet. */ class SketchPlugin_Circle : public SketchPlugin_Feature diff --git a/src/SketchPlugin/SketchPlugin_ConstraintBase.h b/src/SketchPlugin/SketchPlugin_ConstraintBase.h index 721d31029..8636d3948 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintBase.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintBase.h @@ -17,7 +17,7 @@ #include -/* Description: +/** Description: * Each constraint uses a set of parameters. In the SolveSpace library * these parameters are named "valA", "ptA", "ptB", "entityA", "entityB". * The "ptA" and "ptB" parameters represents a point in the constraint. @@ -31,7 +31,7 @@ */ /** \class SketchPlugin_ConstraintBase - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint between other features. * Some feature's methods implemented here as dummy to * Base class for all constraints. diff --git a/src/SketchPlugin/SketchPlugin_ConstraintCoincidence.h b/src/SketchPlugin/SketchPlugin_ConstraintCoincidence.h index 7abe570f2..ce1939f76 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintCoincidence.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintCoincidence.h @@ -13,7 +13,7 @@ #include /** \class SketchPlugin_ConstraintCoincidence - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint which defines equivalence of two points * * This constraint has two attributes: diff --git a/src/SketchPlugin/SketchPlugin_ConstraintDistance.h b/src/SketchPlugin/SketchPlugin_ConstraintDistance.h index 53dfe43e7..69f318798 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintDistance.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintDistance.h @@ -20,7 +20,7 @@ class GeomDataAPI_Point2D; #define DISTANCE_COLOR "#ff00ff" /** \class SketchPlugin_ConstraintDistance - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint which defines a distance * between a point and another feature (point, line, plane or face) * diff --git a/src/SketchPlugin/SketchPlugin_ConstraintLength.h b/src/SketchPlugin/SketchPlugin_ConstraintLength.h index 68141efa3..98ef62511 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintLength.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintLength.h @@ -17,7 +17,7 @@ class GeomDataAPI_Point2D; #define LENGTH_COLOR "#ff00ff" /** \class SketchPlugin_ConstraintLength - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint which defines a length of a line segment * * This constraint has two attributes: diff --git a/src/SketchPlugin/SketchPlugin_ConstraintParallel.h b/src/SketchPlugin/SketchPlugin_ConstraintParallel.h index 6e81c66d3..4f3969073 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintParallel.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintParallel.h @@ -14,7 +14,7 @@ #define PARALLEL_COLOR "#ffff00" /** \class SketchPlugin_ConstraintParallel - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint parallelism of two lines * * This constraint has two attributes: diff --git a/src/SketchPlugin/SketchPlugin_ConstraintPerpendicular.h b/src/SketchPlugin/SketchPlugin_ConstraintPerpendicular.h index 1e1953eee..f0998fa14 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintPerpendicular.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintPerpendicular.h @@ -14,7 +14,7 @@ #define PERPENDICULAR_COLOR "#ffff00" /** \class SketchPlugin_ConstraintPerpendicular - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint for perpendicularity of two lines * * This constraint has two attributes: diff --git a/src/SketchPlugin/SketchPlugin_ConstraintRadius.h b/src/SketchPlugin/SketchPlugin_ConstraintRadius.h index bbdef2055..84c2043c4 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintRadius.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintRadius.h @@ -14,7 +14,7 @@ #define RADIUS_COLOR "#ff00ff" /** \class SketchPlugin_ConstraintRadius - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint which defines * a radius of a circle or an arc of circle * diff --git a/src/SketchPlugin/SketchPlugin_ConstraintRigid.h b/src/SketchPlugin/SketchPlugin_ConstraintRigid.h index 4646ac7fd..5c94bcba6 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintRigid.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintRigid.h @@ -15,7 +15,7 @@ #define FIXING_COLOR "#ffff00" /** \class SketchPlugin_ConstraintRigid - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint which defines immovable object * * This constraint has one attribute: diff --git a/src/SketchPlugin/SketchPlugin_Feature.h b/src/SketchPlugin/SketchPlugin_Feature.h index bf7cb93fa..24a3c49e5 100644 --- a/src/SketchPlugin/SketchPlugin_Feature.h +++ b/src/SketchPlugin/SketchPlugin_Feature.h @@ -20,7 +20,7 @@ class GeomAPI_Pnt2d; class Handle_AIS_InteractiveObject; /**\class SketchPlugin_Feature - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give * an interface to create the sketch feature preview. */ diff --git a/src/SketchPlugin/SketchPlugin_Line.h b/src/SketchPlugin/SketchPlugin_Line.h index be5fadaad..1984f8368 100644 --- a/src/SketchPlugin/SketchPlugin_Line.h +++ b/src/SketchPlugin/SketchPlugin_Line.h @@ -13,7 +13,7 @@ #include /**\class SketchPlugin_Line - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new part in PartSet. */ class SketchPlugin_Line : public SketchPlugin_Feature diff --git a/src/SketchPlugin/SketchPlugin_Plugin.h b/src/SketchPlugin/SketchPlugin_Plugin.h index 9354ef398..3b9de25ef 100644 --- a/src/SketchPlugin/SketchPlugin_Plugin.h +++ b/src/SketchPlugin/SketchPlugin_Plugin.h @@ -14,7 +14,7 @@ #include /**\class SketchPlugin_Plugin - * \ingroup DataModel + * \ingroup Plugins * \brief Interface common for any plugin: allows to use plugin by the plugins manager. */ class SKETCHPLUGIN_EXPORT SketchPlugin_Plugin : public ModelAPI_Plugin, public Events_Listener diff --git a/src/SketchPlugin/SketchPlugin_Point.h b/src/SketchPlugin/SketchPlugin_Point.h index c855dd32a..27a288763 100644 --- a/src/SketchPlugin/SketchPlugin_Point.h +++ b/src/SketchPlugin/SketchPlugin_Point.h @@ -13,7 +13,7 @@ #include /**\class SketchPlugin_Point - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new point. */ class SketchPlugin_Point : public SketchPlugin_Feature diff --git a/src/SketchPlugin/SketchPlugin_Sketch.h b/src/SketchPlugin/SketchPlugin_Sketch.h index 14e3082f0..51ac70496 100644 --- a/src/SketchPlugin/SketchPlugin_Sketch.h +++ b/src/SketchPlugin/SketchPlugin_Sketch.h @@ -24,7 +24,7 @@ #define PLANE_SIZE "200" /**\class SketchPlugin_Sketch - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new part in PartSet. */ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature//, public GeomAPI_IPresentable diff --git a/src/SketchSolver/SketchSolver_Constraint.h b/src/SketchSolver/SketchSolver_Constraint.h index e194c2571..5a98e31be 100644 --- a/src/SketchSolver/SketchSolver_Constraint.h +++ b/src/SketchSolver/SketchSolver_Constraint.h @@ -15,7 +15,7 @@ #include /** \class SketchSolver_Constraint - * \ingroup DataModel + * \ingroup Plugins * \brief Obtain information about SketchPlugin's constraint */ class SketchSolver_Constraint diff --git a/src/SketchSolver/SketchSolver_ConstraintGroup.h b/src/SketchSolver/SketchSolver_ConstraintGroup.h index 94734f20c..36583e338 100644 --- a/src/SketchSolver/SketchSolver_ConstraintGroup.h +++ b/src/SketchSolver/SketchSolver_ConstraintGroup.h @@ -25,7 +25,7 @@ typedef std::map< std::shared_ptr, std::vector /** \class SketchSolver_ConstraintManager - * \ingroup DataModel + * \ingroup Plugins * \brief Listens the changes of SketchPlugin features and transforms the Constraint * feature into the format understandable by SolveSpace library. *