Constriction type for all sketch entities

[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ResultValidators.h

diff --git a/src/SketchPlugin/SketchPlugin_ResultValidators.h b/src/SketchPlugin/SketchPlugin_ResultValidators.h
index 0a6f7a692382020538b8f6bb85a32d8cd1a4017b..6e328b1757d3d6f244293f78c881e08f268a0f56 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_ResultValidators.h
+++ b/src/SketchPlugin/SketchPlugin_ResultValidators.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        Model_ResultValidators.h
 // Created:     23 July 2014
 // Author:      Vitaly SMETANNIKOV
@@ -9,21 +11,42 @@
 #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;
 };