From e1429844d3c7c2feeec8291084fb7f36e9ef38af Mon Sep 17 00:00:00 2001
From: Renaud G <renaud@rolisteam.org>
Date: Thu, 30 Apr 2015 11:09:04 +0200
Subject: add comments and gpl header to those files for better documentation
 in doxygen

---
 validator.h | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

(limited to 'validator.h')

diff --git a/validator.h b/validator.h
index d18a691..6dd8292 100644
--- a/validator.h
+++ b/validator.h
@@ -25,14 +25,35 @@
 #include <Qt>
 #include "die.h"
 #include <QString>
-
+/**
+ * @brief The Validator class is an abstract class for checking the validity of dice for some
+ * operator.
+ */
 class Validator
 {
 public:
+    /**
+     * @brief Validator
+     */
     Validator();
+    /**
+     * @brief hasValid
+     * @param b
+     * @param recursive
+     * @param unlight
+     * @return
+     */
     virtual qint64 hasValid(Die* b,bool recursive,bool unlight = false) const = 0 ;
-
+    /**
+     * @brief toString
+     * @return
+     */
     virtual QString toString()=0;
+    /**
+     * @brief getValidRangeSize
+     * @param faces
+     * @return
+     */
     virtual quint8 getValidRangeSize(quint64 faces) const = 0 ;
 };
 
-- 
cgit v1.2.3-70-g09d2