aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/die.h
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2014-12-06 10:15:13 +0100
committerRenaud G <renaud@rolisteam.org>2014-12-06 10:15:13 +0100
commit9ac00a7658e81a045a68668df7ead5bb7c27254c (patch)
tree92b10c829610bd14b1ec1aad2ab54f23af975624 /die.h
parent3d7029f1b4254403374cb1d8f5cbf2814f2c9ec4 (diff)
downloadOneRoll-9ac00a7658e81a045a68668df7ead5bb7c27254c.tar.gz
OneRoll-9ac00a7658e81a045a68668df7ead5bb7c27254c.zip
-Add comments
Diffstat (limited to 'die.h')
-rw-r--r--die.h66
1 files changed, 61 insertions, 5 deletions
diff --git a/die.h b/die.h
index 99596a9..776b54b 100644
--- a/die.h
+++ b/die.h
@@ -24,31 +24,87 @@
#include <QList>
+/**
+ * @brief The Die class
+ */
class Die
{
public:
+ /**
+ * @brief Die
+ */
Die();
+ /**
+ * @brief setValue
+ * @param r
+ */
void setValue(qint64 r);
+ /**
+ * @brief setFaces
+ * @param face
+ */
void setFaces(quint64 face);
+ /**
+ * @brief insertRollValue
+ * @param r
+ */
void insertRollValue(qint64 r);
+ /**
+ * @brief setSelected
+ * @param b
+ */
void setSelected(bool b);
-
+ /**
+ * @brief isSelected
+ * @return
+ */
bool isSelected() const;
+ /**
+ * @brief getValue
+ * @return
+ */
qint64 getValue() const;
+ /**
+ * @brief getListValue
+ * @return
+ */
QList<qint64> getListValue() const;
-
+ /**
+ * @brief hasChildrenValue
+ * @return
+ */
bool hasChildrenValue();
-
+ /**
+ * @brief roll
+ * @param adding
+ */
void roll(bool adding = false);
+ /**
+ * @brief replaceLastValue
+ * @param value
+ */
void replaceLastValue(qint64 value);
-
+ /**
+ * @brief getLastRolledValue
+ * @return
+ */
qint64 getLastRolledValue();
+ /**
+ * @brief getFaces
+ * @return
+ */
quint64 getFaces();
-
+ /**
+ * @brief hasBeenDisplayed
+ * @return
+ */
bool hasBeenDisplayed();
+ /**
+ * @brief displayed
+ */
void displayed();
private: