diff options
| author | 2015-04-30 11:09:04 +0200 | |
|---|---|---|
| committer | 2015-04-30 11:09:04 +0200 | |
| commit | e1429844d3c7c2feeec8291084fb7f36e9ef38af (patch) | |
| tree | 352d0bcac94201727e75ae55c0ba0da5d1aaf7cb /validator.h | |
| parent | 5c73a6cb13b8c301d0e60f916998c3e683a2b043 (diff) | |
| download | OneRoll-e1429844d3c7c2feeec8291084fb7f36e9ef38af.tar.gz OneRoll-e1429844d3c7c2feeec8291084fb7f36e9ef38af.zip | |
add comments and gpl header to those files for better documentation in doxygen
Diffstat (limited to 'validator.h')
| -rw-r--r-- | validator.h | 25 |
1 files changed, 23 insertions, 2 deletions
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 ; }; |