]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Update the doxygen documentation for plugins
authormpv <mpv@opencascade.com>
Tue, 27 Jan 2015 08:57:42 +0000 (11:57 +0300)
committermpv <mpv@opencascade.com>
Tue, 27 Jan 2015 08:57:42 +0000 (11:57 +0300)
31 files changed:
src/ConstructionPlugin/ConstructionPlugin_Plane.h
src/ConstructionPlugin/ConstructionPlugin_Plugin.h
src/Events/Events_Error.h
src/Events/Events_LongOp.h
src/Events/Events_Loop.h
src/ExchangePlugin/ExchangePlugin_ImportFeature.h
src/ExchangePlugin/ExchangePlugin_Plugin.h
src/ExchangePlugin/ExchangePlugin_Validators.cpp
src/ExchangePlugin/ExchangePlugin_Validators.h
src/FeaturesPlugin/FeaturesPlugin_Boolean.h
src/FeaturesPlugin/FeaturesPlugin_Extrusion.h
src/FeaturesPlugin/FeaturesPlugin_Group.h
src/FeaturesPlugin/FeaturesPlugin_Placement.h
src/FeaturesPlugin/FeaturesPlugin_Plugin.h
src/GeomAPI/GeomAPI_DataMapOfShapeShape.cpp
src/GeomAPI/GeomAPI_DataMapOfShapeShape.h
src/GeomAPI/GeomAPI_ICustomPrs.h
src/GeomAPI/GeomAPI_PlanarEdges.h
src/GeomAPI/GeomAPI_Shape.h
src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h
src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.cpp
src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h
src/PartSetPlugin/PartSetPlugin_Plugin.h
src/SketchPlugin/SketchPlugin_Feature.h
src/SketchPlugin/SketchPlugin_ResultValidators.h
src/SketchPlugin/SketchPlugin_Sketch.h
src/SketchPlugin/SketchPlugin_Validators.h
src/SketchSolver/SketchSolver_Constraint.h
src/SketchSolver/SketchSolver_ConstraintGroup.cpp
src/SketchSolver/SketchSolver_ConstraintGroup.h
src/SketchSolver/SketchSolver_Solver.h

index e58dd2ec4a4e76b7b297b5adc1bfc213d08b94b5..369f20586bf2d0aadd87700b2972d8bf20ba56b0 100644 (file)
@@ -20,9 +20,9 @@ const std::string FACE_ATTR = "planeFace";
 /// attribute name for distance
 const std::string DISTANCE_ATTR = "distance";
 
-/**\class ConstructionPlugin_Axis
+/**\class ConstructionPlugin_Plane
  * \ingroup DataModel
- * \brief Feature for creation of the new axis in PartSet.
+ * \brief Feature for creation of the new planar surface in PartSet.
  */
 class ConstructionPlugin_Plane : public ModelAPI_Feature, public GeomAPI_ICustomPrs
 {
index 39f2449fc5fad4e942953f8015801b66bc39d42c..a7ec72fc43e56b3ff5c4935d27ded5f7e2ad6403 100644 (file)
 #include "ModelAPI_Plugin.h"
 #include "ModelAPI_Feature.h"
 
+/**\class ConstructionPlugin_Plugin
+ * \ingroup Plugins
+ * \brief The main class for management the construction features as plugin.
+ */
 class CONSTRUCTIONPLUGIN_EXPORT ConstructionPlugin_Plugin : public ModelAPI_Plugin
 {
- public:
+public:
   /// Creates the feature object of this plugin by the feature string ID
   virtual FeaturePtr createFeature(std::string theFeatureID);
 
- public:
+  /// Default constructor
   ConstructionPlugin_Plugin();
 };
 
index d3222a28e1ffb5566d4d1a72761c86b283ba3108..561c987ce141be705eb03dc88f7b049babde742b 100644 (file)
 
 #include <string>
 
+/**\class Events_Error
+ * \ingroup EventsLoop
+ * \brief An error message event.
+ *
+ * Is generated by any algorithm or GUI of the application to inform the user about
+ * the problem. In GUI mode all such errors are collected in the message log window.
+ */
 class EVENTS_EXPORT Events_Error : public Events_Message
 {
   char* myDescription;  ///< pointer to the description of the error
 
- public:
+public:
+  /// default destructor   
   virtual ~Events_Error();
 
+  /// Identifier of this event (one for all errors)
   static Events_ID errorID();
+  /// Specific error string
   char* description() const;
+  /// Allows to send an error quickly: it creates and sends the error object automatically
   static void send(char* theDescription, const void* theSender = 0);
+  /// Allows to send an error quickly: it creates and sends the error object automatically
   static void send(std::string theDescription, const void* theSender = 0);
 
- protected:
+protected:
+  /// Default constructor. Use "send" message for generation an error.
   Events_Error(char* theDescription, const void* theSender = 0);
 };
 
index f8e5dd8f2b2ee22794a2a618a7ad61ad0dc815ff..c2e6c2e2eb02e24e2a91b46dc5b529df479712cb 100644 (file)
@@ -16,7 +16,8 @@
  */
 class EVENTS_EXPORT Events_LongOp : public Events_Message
 {
- public:
+public:
+  /// Default destructor
   virtual ~Events_LongOp();
   /// Returns the identifier of this event
   static Events_ID eventID();
@@ -27,7 +28,8 @@ class EVENTS_EXPORT Events_LongOp : public Events_Message
   /// Returns true if the long operation is performed
   static bool isPerformed();
 
- protected:
+protected:
+  /// Default constructor. Use "start" and "end" for generation.
   Events_LongOp(void* theSender = 0);
 };
 
index af5a0c0ddaca0fbb40b89dfb31decdb7c48f08fc..a11426f1b99263f8581a0d4b5640c14db9167bd3 100644 (file)
@@ -54,6 +54,7 @@ class Events_Loop
   EVENTS_EXPORT static Events_ID eventByName(const char* theName);
 
   //! Allows to send an event
+  //! \param theMessage the enevt message to send
   //! \param isGroup is true for grouping messages if possible
   EVENTS_EXPORT void send(const std::shared_ptr<Events_Message>& theMessage, bool isGroup = true);
 
index f62fee937663c61eb31e5f33a126e04d93f2b726..24bd6964f503b3fdb5d0b6a5db912082f10f52b3 100644 (file)
@@ -8,6 +8,12 @@
 
 #include <map>
 
+/**\class ExchangePlugin_ImportFeature
+ * \ingroup Plugins
+ * \brief Feature for import shapes from the external files in CAD formats.
+ *
+ * The set of supported formats is defined in the configuration file.
+ */
 class ExchangePlugin_ImportFeature : public ModelAPI_Feature
 {
  public:
@@ -23,8 +29,9 @@ class ExchangePlugin_ImportFeature : public ModelAPI_Feature
     static const std::string MY_FILE_PATH_ID("import_file_selector");
     return MY_FILE_PATH_ID;
   }
-
+  /// default constructor
   EXCHANGEPLUGIN_EXPORT ExchangePlugin_ImportFeature();
+  /// default destructor
   EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ImportFeature();
 
   /// Returns the unique kind of a feature
@@ -42,6 +49,7 @@ class ExchangePlugin_ImportFeature : public ModelAPI_Feature
   }
 
  protected:
+  /// POerforms the import of the file
   EXCHANGEPLUGIN_EXPORT bool importFile(const std::string& theFileName);
 
 private:
index 89531bd8a225a3dccf26d764875132f95f592a3d..97e1534c713424ed665b76eca29e403bf84b885d 100644 (file)
 #include <ModelAPI_Plugin.h>
 #include <ModelAPI_Feature.h>
 
+/**\class ExchangePlugin_Plugin
+ * \ingroup Plugins
+ * \brief The main class for management the import and export operations as plugin.
+ */
 class EXCHANGEPLUGIN_EXPORT ExchangePlugin_Plugin : public ModelAPI_Plugin
 {
  public:
index e708041a8f7e034bc342fa8ddb0706b56ec85e91..c001a0c3f41585bd42416e2b7ca68ec4822807d3 100644 (file)
@@ -33,23 +33,6 @@ bool ExchangePlugin_ImportFormatValidator::parseFormats(const std::list<std::str
   return result;
 }
 
-bool ExchangePlugin_ImportFormatValidator::parsePlugins(const std::list<std::string>& theArguments,
-                                                        std::list<std::string>& outPlugins)
-{
-  std::list<std::string>::const_iterator it = theArguments.begin();
-  bool result = true;
-  for (; it != theArguments.end(); ++it) {
-    std::string anArg = *it;
-    int aSepPos = anArg.find(":");
-    if (aSepPos == std::string::npos) {
-      result = false;
-      continue;
-    }
-    outPlugins.push_back(anArg.substr(aSepPos + 1));
-  }
-  return result;
-}
-
 bool ExchangePlugin_ImportFormatValidator::isValid(const AttributePtr& theAttribute,
                                                    const std::list<std::string>& theArguments) const
 {
index 1e93f95accb8c8d164b6882b3bedbcbeb4e42961..f8db19fc21857ae0e17ecea369e868b4340d7b93 100644 (file)
 #include "ExchangePlugin.h"
 #include <ModelAPI_AttributeValidator.h>
 
+/**\class ExchangePlugin_ImportFormatValidator
+ * \ingroup Validators
+ * \brief Validator for the imported formats checking
+ *
+ * The configuration file of import/export features contains the information
+ * about which formats are supported and the extension of the associated files.
+ * This validator filters out files that are out of this description.
+ */
 class ExchangePlugin_ImportFormatValidator : public ModelAPI_AttributeValidator
 {
-  /*
+  /**
    * Parses input arguments "BREP:BREPImport", "STEP:STEPImport"
    * into list of file formats "BREP","STEP"
    * and list of corresponding plugins: "BREPImport", "STEPImport"
    */
   static bool parseFormats(const std::list<std::string>& theArguments,
                              std::list<std::string>& outFormats);
-  static bool parsePlugins(const std::list<std::string>& theArguments,
-                           std::list<std::string>& outPlugins);
- public:
+public:
+  /**
+   * Returns true is the file-name attribute correctly corresponds to the set of
+   * allowed formats.
+   */
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments) const;
 
index 824dcd0dbb5dd787032974c50c93f6c0b95dde69..65ad15d2e99f2ba424a3ebb50e75681d613d8713 100644 (file)
 #include <GeomAPI_Shape.h>
 #include <GeomAlgoAPI_Boolean.h>
 
+/**\class FeaturesPlugin_Boolean
+ * \ingroup Plugins
+ * \brief Feature for applying of Boolean operations on Solids.
+ *
+ * Supports three kinds of Boolean operations: Cut, Fuse and Common.
+ * For all of them requires two Solids: object and tool.
+ */
 class FeaturesPlugin_Boolean : public ModelAPI_Feature
 {
- public:
+public:
   /// Extrusion kind
   inline static const std::string& ID()
   {
@@ -46,7 +53,6 @@ class FeaturesPlugin_Boolean : public ModelAPI_Feature
     BOOL_COMMON
   };
 
-
   /// Returns the kind of a feature
   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
   {
index 8199fcb2e131bdb039f368f6eba5d55bab2a14a6..bbc636c9251fdda8b8d7a64f0f654dfe6dfbd92a 100644 (file)
 #include <ModelAPI_ResultBody.h>
 #include <GeomAlgoAPI_Extrusion.h>
 #include <GeomAPI_Shape.h>
+
+/**\class FeaturesPlugin_Extrusion
+ * \ingroup Plugins
+ * \brief Feature for creation of extrusion from the planar face.
+ *
+ * Extrusion creates the lateral faces based on edges of the base face and
+ * the top face equal to the base face. Direction of extrusion is taken from the face
+ * plane, but can be corrected by the "reverse" flag.
+ */
 class FeaturesPlugin_Extrusion : public ModelAPI_Feature
 {
  public:
index e859d5e89b562a99f87cce07d3dbe053a22143ef..50f82339a359872d68b1867a1c59ed9a22c7ea83 100644 (file)
 #include <ModelAPI_Feature.h>
 #include <GeomAPI_Shape.h>
 
+/**\class FeaturesPlugin_Group
+ * \ingroup Plugins
+ * \brief Feature for selection of sub-shapes of some shapes.
+ *
+ * All selected sub-shapes must be of equal type (vertex, edge, face, etc) but may
+ * be selected on different objects.
+ */
 class FeaturesPlugin_Group : public ModelAPI_Feature
 {
  public:
@@ -20,12 +27,6 @@ class FeaturesPlugin_Group : public ModelAPI_Feature
     static const std::string MY_GROUP_ID("Group");
     return MY_GROUP_ID;
   }
-  /// attribute name of group name
-  //inline static const std::string& NAME_ID()
-  //{
-  //  static const std::string MY_GROUP_NAME_ID("group_name");
-  //  return MY_GROUP_NAME_ID;
-  //}
   /// attribute name of selected entities list
   inline static const std::string& LIST_ID()
   {
index 3cfd358874a21a7d361df35dbe086aae70c3206b..e96541de32bf43b44a7b147077f6d97ac611a45a 100644 (file)
 class ModelAPI_ResultBody;
 class GeomAPI_Shape;
 
+/**\class FeaturesPlugin_Placement
+ * \ingroup Plugins
+ * \brief Feature for applying of placement operation: relative movement of Solid.
+ *
+ * Locates the selected attractable_face of the solid in the middle of the selected
+ * placement_base face. Faces must be planar. Orientation of the placed solid is
+ * depended on the underlied planes of both faces.
+ */
 class FeaturesPlugin_Placement : public ModelAPI_Feature
 {
  public:
index 651de9badeffa4e5ee1b4fc61f873d9b7fa248f1..64750feedaf1df11a72a73afae4a0baa0dd459dc 100644 (file)
 #include <ModelAPI_Plugin.h>
 #include <ModelAPI_Feature.h>
 
+/**\class FeaturesPlugin_Plugin
+ * \ingroup Plugins
+ * \brief The main class for management the 3D features as plugin.
+ */
 class FEATURESPLUGIN_EXPORT FeaturesPlugin_Plugin : public ModelAPI_Plugin
 {
  public:
@@ -18,6 +22,7 @@ class FEATURESPLUGIN_EXPORT FeaturesPlugin_Plugin : public ModelAPI_Plugin
   virtual FeaturePtr createFeature(std::string theFeatureID);
 
  public:
+  /// Default constructor
   FeaturesPlugin_Plugin();
 };
 
index c42ef1562edac8a5ea29487a597c983ba77c68ba..97e3f10683127f11da42d3fe25b3b18ba3540267 100644 (file)
@@ -14,19 +14,16 @@ using namespace std;
 GeomAPI_DataMapOfShapeShape::GeomAPI_DataMapOfShapeShape()
        :GeomAPI_Interface((void *)new TopTools_DataMapOfShapeShape){}
 
-/// Clear 
 void GeomAPI_DataMapOfShapeShape::clear()
 {
   implPtr<TopTools_DataMapOfShapeShape>()->Clear();
 }
 
-/// Size 
 int GeomAPI_DataMapOfShapeShape::size()
 {
   return implPtr<TopTools_DataMapOfShapeShape>()->Extent();
 }
 
-/// Adds the Key <K> to  the Map <me>  with  the  Item. Returns True  if the Key  was not already in the map
 bool GeomAPI_DataMapOfShapeShape::bind (std::shared_ptr<GeomAPI_Shape> theKey, std::shared_ptr<GeomAPI_Shape> theItem)
 {
   bool flag(false);
@@ -35,7 +32,6 @@ bool GeomAPI_DataMapOfShapeShape::bind (std::shared_ptr<GeomAPI_Shape> theKey, s
   return flag;
 }
 
-/// Returns true if theKey is stored  in the map.
 bool GeomAPI_DataMapOfShapeShape::isBound (std::shared_ptr<GeomAPI_Shape> theKey)
 {
   bool flag(false);
@@ -44,7 +40,6 @@ bool GeomAPI_DataMapOfShapeShape::isBound (std::shared_ptr<GeomAPI_Shape> theKey
   return flag;
 }
 
-/// Returns  the Item stored  with the Key in the Map. To be checked before with isBound()
 const std::shared_ptr<GeomAPI_Shape> GeomAPI_DataMapOfShapeShape::find(std::shared_ptr<GeomAPI_Shape> theKey)
 {
   std::shared_ptr<GeomAPI_Shape> aShape(new GeomAPI_Shape());  
@@ -52,7 +47,6 @@ const std::shared_ptr<GeomAPI_Shape> GeomAPI_DataMapOfShapeShape::find(std::shar
   return aShape;
 }  
   
-/// Removes the Key from the  map. Returns true if the Key was in the Map
 bool GeomAPI_DataMapOfShapeShape::unBind(std::shared_ptr<GeomAPI_Shape> theKey)
 {
   bool flag(false);
index 40c447baed4d31ff5d5c083391ca584a90b4d50e..24d3db14ed4562770f69ef54a0cd510683c1826a 100644 (file)
@@ -17,7 +17,6 @@ class GeomAPI_Dir;
  * \ingroup DataModel
  * \brief DataMap of Shape - Shape defined by TopoDS_Shapes
  */
-
 class GEOMAPI_EXPORT GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface
 {
  public:
@@ -30,7 +29,7 @@ class GEOMAPI_EXPORT GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface
   /// Size of the map
   int size();
 
-  /// Adds the Key <K> to  the Map <me>  with  the  Item. Returns True  if the Key  was not already in the map
+  /// Adds \a theKey to me with \a theItem. Returns True if the Key  was not already in the map
   bool bind (std::shared_ptr<GeomAPI_Shape> theKey, std::shared_ptr<GeomAPI_Shape> theItem);
 
   /// Returns true if theKey is stored  in the map.
index c398a33bce83e204803d9bfc3fa7dd6bfbba7e80..cbed444b76919614476c2d0ea53f5a0068926f26 100644 (file)
@@ -16,6 +16,7 @@
 class GeomAPI_ICustomPrs
 {
 public:
+  /// Modifies the given presentation in the custom way.
   virtual void customisePresentation(AISObjectPtr thePrs) = 0;
 };
 
index a9cd54a31679cd0453b185caa936f52235f6b06d..627bc5d719cfded780ee8c181ba13a29d18103c2 100644 (file)
 
 /**\class GeomAPI_PlanarEdges
  * \ingroup DataModel
- * \brief Interface to the edge object
+ * \brief Interface to the set of edges located in one plane
+ *
+ * Normally this interface corresponds to theedges of the sketch
  */
-
 class GeomAPI_PlanarEdges : public GeomAPI_Shape
 {
  public:
   /// Creation of empty (null) shape
   GEOMAPI_EXPORT GeomAPI_PlanarEdges();
 
+  /// Returns whether the shape is alone vertex
   GEOMAPI_EXPORT virtual bool isVertex() const;
 
-  /// Returns whether the shape is an edge
+  /// Returns whether the shape is alone edge
   GEOMAPI_EXPORT virtual bool isEdge() const;
-
+  /// Appends the edge to the set
   GEOMAPI_EXPORT void addEdge(std::shared_ptr<GeomAPI_Shape> theEdge);
+  /// Returns the list of edges in this interface
   GEOMAPI_EXPORT std::list<std::shared_ptr<GeomAPI_Shape> > getEdges();
 
   /// Returns True if the wire is defined in a plane
   GEOMAPI_EXPORT bool hasPlane() const;
 
-  /// Set/Get origin point
+  /// Sets origin point
   GEOMAPI_EXPORT void setOrigin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin);
 
+  /// Returns the plane origin point
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> origin() const;
 
-  /// Set/Get X direction vector
+  /// Sets X direction vector
   GEOMAPI_EXPORT void setDirX(const std::shared_ptr<GeomAPI_Dir>& theDirX);
+  /// Returns X direction vector
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirX() const;
 
-  /// Set/Get Y direction vector
+  /// Sets Y direction vector
   GEOMAPI_EXPORT void setDirY(const std::shared_ptr<GeomAPI_Dir>& theDirY);
+  /// Returns Y direction vector
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirY() const;
 
-  /// Set/Get Normal direction vector
+  /// Sets Z direction vector
   GEOMAPI_EXPORT void setNorm(const std::shared_ptr<GeomAPI_Dir>& theNorm);
+  /// Returns Z direction vector
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> norm() const;
 
 private:
+  /// Origin point of the plane
   std::shared_ptr<GeomAPI_Pnt> myOrigin;
+  /// The X direction inside of the plane
   std::shared_ptr<GeomAPI_Dir> myDirX;
+  /// The Y direction inside of the plane
   std::shared_ptr<GeomAPI_Dir> myDirY;
+  /// The normal direction to the plane
   std::shared_ptr<GeomAPI_Dir> myNorm;
 };
 
index 8ff96d9815ca5e00c3e93ed1d2dc5e2b201a6100..8e2c22f9a41afe72addb07b7cb9c353fb3cf69b7 100644 (file)
@@ -21,6 +21,7 @@ class GEOMAPI_EXPORT GeomAPI_Shape : public GeomAPI_Interface
   /// Creation of empty (null) shape
   GeomAPI_Shape();
 
+  /// Returns true if the underlied shape is null
   bool isNull() const;
 
   /// Returns whether the shapes are equal
@@ -40,6 +41,7 @@ class GEOMAPI_EXPORT GeomAPI_Shape : public GeomAPI_Interface
   bool computeSize(double& theXmin, double& theYmin, double& theZmin,
                    double& theXmax, double& theYmax, double& theZmax) const;
 
+  /// Returns the shape as BRep stream
   std::string getShapeStream() const;
 };
 
index ac7b267d0eb4f4c0aba8c772c45b7b5c63d32799..a8a5659de8ea2470759c9cd481f87936663de983 100644 (file)
 class GeomAlgoAPI_Boolean : public GeomAPI_Interface
 {
  public:
-  /* \brief Creates cut boolean operation
+  /**\brief Creates cut boolean operation
    * \param[in] theShape the main shape
    * \param[in] theTool  toole shape for boolean
    * \return a solid as result of operation
    */
   GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> makeCut(
                                                  std::shared_ptr<GeomAPI_Shape> theShape,
-                                              std::shared_ptr<GeomAPI_Shape> theTool);
+                                            std::shared_ptr<GeomAPI_Shape> theTool);
 
-  /* \brief Creates fuse boolean operation
+  /**\brief Creates fuse boolean operation
    * \param[in] theShape the main shape
    * \param[in] theTool  second shape
    * \return a solid as result of operation
@@ -38,10 +38,9 @@ class GeomAlgoAPI_Boolean : public GeomAPI_Interface
                                                  std::shared_ptr<GeomAPI_Shape> theShape,
                                               std::shared_ptr<GeomAPI_Shape> theTool);
 
-  /* \brief Creates common boolean operation
+  /**\brief Creates common boolean operation
    * \param[in] theObject the main shape
    * \param[in] theTool  second shape
-   * \param[in] theType  type of the operation: Fuse, Cut, Common
    * \return a solid as result of operation
    */
   GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> makeCommon(
index f28779de5f60f244d5c41124d2541b00fdeefcbf..4682f1fb0c760213ab57f52b24533b17ac25abe7 100644 (file)
@@ -27,7 +27,6 @@ const std::shared_ptr<GeomAPI_Shape> GeomAlgoAPI_MakeShape::shape() const
   return myShape;
 }
 
-/// Returns the  list   of shapes generated   from the shape <theShape>
 void GeomAlgoAPI_MakeShape::generated(
   const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory)
 {
@@ -43,7 +42,6 @@ void GeomAlgoAPI_MakeShape::generated(
   }
 }
 
-/// Returns the  list   of shapes modified   from the shape <theShape>
 void GeomAlgoAPI_MakeShape::modified(
   const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory)
 {
@@ -59,7 +57,6 @@ void GeomAlgoAPI_MakeShape::modified(
   }
 }
 
-/// Returns whether the shape is an edge
 bool GeomAlgoAPI_MakeShape::isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape)
 {
   bool isDeleted(false);
index 25812634c1324b30302cc280d47df2eb1ae937ec..4082464af400eb496fead480e3019ab41d59aa2e 100644 (file)
@@ -9,36 +9,37 @@
 #include <GeomAPI_Shape.h>
 #include <memory>
 #include <GeomAlgoAPI.h>
-//#include <BRepBuilderAPI_MakeShape.hxx>
+
 /**\class GeomAlgoAPI_MakeShape
  * \ingroup DataModel
  * \brief Interface to the root class of all topological shapes constructions
  */
 class GeomAlgoAPI_MakeShape : public GeomAPI_Interface
 {
- public:
-   /// Constructor
+public:
+  /// Constructor
   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape();
-
+  /// Constructor by the already stored builder in the interface
   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(void* theBuilder);
 
   /// Returns a shape built by the shape construction algorithm
   GEOMALGOAPI_EXPORT const std::shared_ptr<GeomAPI_Shape>  shape() const;
 
-  /// Returns the  list   of shapes generated   from the shape <theShape>
+  /// Returns the list of shapes generated from the shape \a theShape
   GEOMALGOAPI_EXPORT virtual void generated(
     const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory);
 
-  /// Returns the  list   of shapes modified   from the shape <theShape>
+  /// Returns the  list of shapes modified from the shape \a theShape
   GEOMALGOAPI_EXPORT virtual void modified(
     const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory);
 
   /// Returns whether the shape is an edge
   GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
-
+  /// Initializes the algorithm by the builder stored in the interface
   GEOMALGOAPI_EXPORT void init(void* theMkShape);
 
   protected:
+  /// The resulting shape
        std::shared_ptr<GeomAPI_Shape> myShape;
 };
 
index 364ebb48dfbf4f12e2fbd571930136890e3c3b0b..59ace5aa844925d932003f95b08eb89d41727d25 100644 (file)
 
 #include <memory>
 
+/**\class FeaturesPlugin_Plugin
+ * \ingroup Plugins
+ * \brief The main class for management the part set operations as plugin.
+ */
 class PARTSETPLUGIN_EXPORT PartSetPlugin_Plugin : public ModelAPI_Plugin,
                                                   public Events_Listener
 {
index b69de135ba91d246cd0ef9e24ded6df0bf745563..bf7cb93fabc27bd87eb40d1cd7237ebe4eb508c7 100644 (file)
@@ -55,6 +55,7 @@ class SketchPlugin_Feature : public ModelAPI_Feature, public GeomAPI_ICustomPrs
   /// Returns true is sketch element is under the rigid constraint
   SKETCHPLUGIN_EXPORT virtual bool isFixed() {return false;}
 
+  /// Returns true of the feature is created basing on the external shape of not-this-sketch object
   inline bool isExternal() const
   {
     AttributeSelectionPtr aAttr = data()->selection(EXTERNAL_ID());
index d5100d8fcbd040ab1033a8ae2f60d2df3cc298a2..6e328b1757d3d6f244293f78c881e08f268a0f56 100644 (file)
 #include <ModelAPI_ResultValidator.h>
 #include <ModelAPI_Object.h>
 
+/**\class SketchPlugin_ResultPointValidator
+ * \ingroup Validators
+ * \brief Validator for the points selection
+ *
+ * Allows to select points only.
+ */
 class SketchPlugin_ResultPointValidator : public ModelAPI_ResultValidator
 {
- public:
+public:
+  /// Returns true if theObject is a point
   SKETCHPLUGIN_EXPORT virtual bool isValid(const ObjectPtr theObject) const;
 };
 
+/**\class SketchPlugin_ResultLineValidator
+ * \ingroup Validators
+ * \brief Validator for the linear segments selection
+ *
+ * Allows to select linear segments only.
+ */
 class SketchPlugin_ResultLineValidator : public ModelAPI_ResultValidator
 {
- public:
+public:
+  /// Returns true if theObject is a line
   SKETCHPLUGIN_EXPORT virtual bool isValid(const ObjectPtr theObject) const;
 };
 
+/**\class SketchPlugin_ResultArcValidator
+ * \ingroup Validators
+ * \brief Validator for the circular segments selection
+ *
+ * Allows to select circular segments only.
+ */
 class SketchPlugin_ResultArcValidator : public ModelAPI_ResultValidator
 {
  public:
+  /// Returns true if theObject is an arc
   SKETCHPLUGIN_EXPORT virtual bool isValid(const ObjectPtr theObject) const;
 };
 
index a65fbb197acfc781006b9a927c2d1db539104c8f..14e3082f0e6250231532dbc1232256231e87ecca 100644 (file)
@@ -139,14 +139,6 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature//, public GeomAPI_I
 
   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 protected:
-  /// Creates a plane and append it to the list
-  /// \param theX the X normal value
-  /// \param theY the Y normal value
-  /// \param theZ the Z normal value
-  /// \param theShapes the list of result shapes
-  //void addPlane(double theX, double theY, double theZ,
-  //              std::list<std::shared_ptr<GeomAPI_Shape> >& theShapes) const;
-
   /// Checks whether the plane is set in the sketch.
   /// \returns the boolean state
   bool isPlaneSet();
index 2f675c4f4fcc46150eb1cfc8b70463fb49a1ff20..0e94d7a70152f50fe66a01f4c65eea2a91b5e74d 100644 (file)
 #include "SketchPlugin.h"
 #include <ModelAPI_RefAttrValidator.h>
 
+/**\class SketchPlugin_DistanceAttrValidator
+ * \ingroup Validators
+ * \brief Validator for the distance input.
+ *
+ * It just checks that distance is greater than zero.
+ */
 class SketchPlugin_DistanceAttrValidator : public ModelAPI_RefAttrValidator
 {
  public:
@@ -27,7 +33,9 @@ class SketchPlugin_DistanceAttrValidator : public ModelAPI_RefAttrValidator
                        const AttributePtr& theAttribute) const { return true; };
 };
 
-/**
+/**\class SketchPlugin_DifferentObjectsValidator
+ * \ingroup Validators
+ *
  * Check that there is no same object was already selected in the feature.
  * For an example: to avoid perpendicularity on line and the same line.
  */
index 4520bf3a585e0c31a6cb0fad0e618715f519b76d..e194c2571cf48619bd2530d00415884b3a50d5d3 100644 (file)
  */
 class SketchSolver_Constraint
 {
- public:
+public:
+  /// Default constructor
   SketchSolver_Constraint();
+  /// Creates constraint to manage the given constraint from plugin
   SketchSolver_Constraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
   /** \brief Compute constraint type according to SolveSpace identifiers
index 6a6fe158e47ef4e8f06eb711ae9d1876c381eaa5..1b1a621c251d6a46d114c6a4baf646aa5b77ade7 100644 (file)
 /// Tolerance for value of parameters
 const double tolerance = 1.e-10;
 
-/*
+/**
  * Collects all sketch solver error' codes
  * as inline static functions
- * TODO: Move this class into a separate file
  */
+ // TODO: Move this class into a separate file
 class SketchSolver_Error
 {
  public:
index 2a5fe600cea6e55df2b82c7ff9f43e16ea85be1c..94734f20c0f0edec67accf815efd79046fe9f99d 100644 (file)
@@ -62,6 +62,10 @@ class SketchSolver_ConstraintGroup
    *  \return \c true if the constraint added or updated successfully
    */
   bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  /** \brief Adds or updates a rigid constraint in the group
+   *  \param[in] theConstraint constraint to be changed
+   *  \return \c true if the constraint added or updated successfully
+   */
   bool changeRigidConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
   /** \brief Verifies the feature attributes are used in this group
@@ -76,6 +80,7 @@ class SketchSolver_ConstraintGroup
    */
   bool isBaseWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
 
+  /// Returns the current workplane
   std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
   {
     return mySketch;
index fd2e5213256f245e86d72ee6d8e6c9aa798eefd8..7079f1598549d2660c1c15102dce44a84a18bba4 100644 (file)
@@ -27,6 +27,9 @@ typedef unsigned int UINT32;
 // Unknown entity
 #define SLVS_E_UNKNOWN 0
 
+/**
+ * The main class that performs the high-level operations for connection to the SolveSpace.
+ */
 class SketchSolver_Solver
 {
  public: