Salome HOME
Fix for issue #417
[modules/shaper.git] / src / ModelAPI / ModelAPI_ResultValidator.h
index f106d96dd0909fef860e8971fd8eac042df04fde..01d73eaed9e9cd77735cee7d080b6f3c7b299d43 100644 (file)
 #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;
 };