Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0

[modules/shaper.git] / src / ModelAPI / ModelAPI_ResultValidator.h

diff --git a/src/ModelAPI/ModelAPI_ResultValidator.h b/src/ModelAPI/ModelAPI_ResultValidator.h
index b18709a144a7a5e0e7195c586e43c8cf2269fad3..01d73eaed9e9cd77735cee7d080b6f3c7b299d43 100644 (file)
--- a/src/ModelAPI/ModelAPI_ResultValidator.h
+++ b/src/ModelAPI/ModelAPI_ResultValidator.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_ResultValidators.h
 // Created:     23 July 2014
 // Author:      Vitaly SMETANNIKOV
@@ -8,9 +10,19 @@
 #include "ModelAPI_Validator.h"
 #include "ModelAPI_Object.h"
 
+/**\class ModelAPI_ResultValidator
+ * \ingroup DataModel
+ * \brief The base class for selection filter for results of features.
+ *
+ * The referenced arguments of feature is normally results displayed in the viewer or by the 
+ * selection attribute. This filter allows to filter out the results not usable as this argument.
+ */
 class ModelAPI_ResultValidator : public ModelAPI_Validator
 {
- public:
+public:
+  /// The abstract method for implementation in the specific validator.
+  /// \param theObject the checked object as an argument
+  /// \returns true if object is OK for this filter
   virtual bool isValid(const ObjectPtr theObject) const = 0;
 };