From 9ac00a7658e81a045a68668df7ead5bb7c27254c Mon Sep 17 00:00:00 2001
From: Renaud G <renaud@rolisteam.org>
Date: Sat, 6 Dec 2014 10:15:13 +0100
Subject: -Add comments

---
 die.h | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 61 insertions(+), 5 deletions(-)

(limited to 'die.h')

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:
-- 
cgit v1.2.3-70-g09d2