SketchPlugin documentation update

diff --git a/src/SketchPlugin/SketchPlugin_ExternalValidator.h b/src/SketchPlugin/SketchPlugin_ExternalValidator.h
index c2773d23a4e9ac4138c3d996649431e2d5ad8deb..821b27de77b9c3cd5ea2247d55deb25cbe8edea1 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_ExternalValidator.h
+++ b/src/SketchPlugin/SketchPlugin_ExternalValidator.h
@@ -10,7 +10,7 @@
 #include <SketchPlugin.h>
 #include <ModelAPI_AttributeValidator.h>
 
-/**\class SketchPlugin_ResultPointValidator
+/**\class SketchPlugin_ExternalValidator
  * \ingroup Validators
  * \brief Validator for the points selection
  *
@@ -23,6 +23,7 @@ public:
   /// among attributes listed in the arguments
   /// \param theAttribute an attribute to check
   /// \param theArguments a filter parameters
+  /// \param theError error message
   SKETCHPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                            const std::list<std::string>& theArguments,
                                            std::string& theError) const;

diff --git a/src/SketchPlugin/SketchPlugin_Sketch.h b/src/SketchPlugin/SketchPlugin_Sketch.h
index cef6307e658255d11adecb1bf8a8b384784f5cd7..8a1788c5c0a18d863f38dacfff28e08f482f86d2 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_Sketch.h
+++ b/src/SketchPlugin/SketchPlugin_Sketch.h
@@ -202,6 +202,8 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
 
 
   /// \brief Create a result for the point in the attribute if the attribute is initialized
+  /// \param theFeature a source feature
+  /// \param theSketch a sketch intance
   /// \param theAttributeID an attribute string
   /// \param theIndex an index of the result
   static void createPoint2DResult(ModelAPI_Feature* theFeature,
@@ -211,8 +213,9 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
   /// Add new feature and fill the data of the feature by the data of the parameter feature.
   /// The name of the created feature stays unique.
   /// \param theFeature a source feature
+  /// \param theSketch a sketch intance
   /// \return a created feature
-  static FeaturePtr addUniqueNamedCopiedFeature(FeaturePtr aFeature,
+  static FeaturePtr addUniqueNamedCopiedFeature(FeaturePtr theFeature,
                                                 SketchPlugin_Sketch* theSketch);
 
   /// Creates a plane of the sketch.

diff --git a/src/SketchPlugin/SketchPlugin_Validators.h b/src/SketchPlugin/SketchPlugin_Validators.h
index 7016177d51799ab22fb5ece8476395911a2af7f1..da003f8b0368dab2b514bc398ee5bbf3a1ee405b 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_Validators.h
+++ b/src/SketchPlugin/SketchPlugin_Validators.h
@@ -23,6 +23,7 @@ class SketchPlugin_DistanceAttrValidator : public ModelAPI_AttributeValidator
   //! returns true if attribute is valid
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute
+  //! \param theError error message
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;
@@ -40,13 +41,14 @@ class SketchPlugin_TangentAttrValidator : public ModelAPI_AttributeValidator
   //! returns true if attribute is valid
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute
+  //! \param theError error message
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;
 };
 
 
-/**\class SketchPlugin_NotFixed
+/**\class SketchPlugin_NotFixedValidator
  * \ingroup Validators
  * \brief Validator for the rigid constraint input.
  *
@@ -58,6 +60,7 @@ class SketchPlugin_NotFixedValidator : public ModelAPI_AttributeValidator
   //! returns true if attribute is not used in another rigid constraint
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute
+  //! \param theError error message
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;
@@ -75,6 +78,7 @@ class SketchPlugin_EqualAttrValidator : public ModelAPI_AttributeValidator
   //! returns true if attribute is valid
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute
+  //! \param theError error message
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;
@@ -92,6 +96,7 @@ class SketchPlugin_MirrorAttrValidator : public ModelAPI_AttributeValidator
   //! returns true if attribute is valid
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute (not used)
+  //! \param theError error message
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;
@@ -110,6 +115,7 @@ class SketchPlugin_CoincidenceAttrValidator : public ModelAPI_AttributeValidator
   //! returns true if attribute is valid
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute (not used)
+  //! \param theError error message
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;
@@ -129,6 +135,7 @@ class SketchPlugin_CopyValidator : public ModelAPI_AttributeValidator
   //! returns true if attribute is valid
   //! \param theAttribute the checked attribute
   //! \param theArguments arguments of the attribute (not used)
+  //! \param theError error message
   virtual bool isValid(const AttributePtr& theAttribute,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;
@@ -146,6 +153,7 @@ class SketchPlugin_SolverErrorValidator : public ModelAPI_FeatureValidator
   //! returns true if there are no solver errors
   //! \param theFeature the checked feature
   //! \param theArguments arguments of the feature (not used)
+  //! \param theError error message
   virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const std::list<std::string>& theArguments,
                        std::string& theError) const;