From 4114232457cbc5739872f479ef5d7772e6b5f42f Mon Sep 17 00:00:00 2001
From: Renaud G <renaud@rolisteam.org>
Date: Fri, 3 Jan 2014 09:03:19 +0100
Subject: Adding new stuff and comment

---
 diceparser.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'diceparser.h')

diff --git a/diceparser.h b/diceparser.h
index 2905584..6833a92 100644
--- a/diceparser.h
+++ b/diceparser.h
@@ -5,6 +5,20 @@
 #include <QMap>
 #include "node/executionnode.h"
 
+/**
+ * @mainpage DiceParser
+ *
+ * the grammar is something like this:
+ *
+ * Command =: Expression | ScalarOperator Expression
+ * Expression =: number | number Dice | Command
+ * Dice =: DiceOperator Number(faces)
+ * DiceOperator =: D
+ * ScalarOperator =: [x,-,*,x,/]
+ * number =: [0-9]+
+ *
+ */
+
 class Dice;
 /**
  * @brief The DiceParser class facade class, it receives a command and return a DiceResult class (not yet implemented).
@@ -75,6 +89,9 @@ private:
     ExecutionNode* m_current;
 };
 
+/**
+ * @brief The Dice class is a basic class to store dice. (May not be required any more).
+ */
 class Dice
 {
 public:
-- 
cgit v1.2.3-70-g09d2