add comments and gpl header to those files for better documentation in doxygen

7 files changed, 174 insertions, 5 deletions

diff --git a/node/numbernode.cpp b/node/numbernode.cpp
index 51a859f..ba063db 100644
--- a/node/numbernode.cpp
+++ b/node/numbernode.cpp
@@ -1,3 +1,24 @@
+/***************************************************************************
+* Copyright (C) 2014 by Renaud Guezennec                                   *
+* http://renaudguezennec.homelinux.org/accueil,3.html                      *
+*                                                                          *
+*  This file is part of DiceParser                                         *
+*                                                                          *
+* DiceParser is free software; you can redistribute it and/or modify       *
+* it under the terms of the GNU General Public License as published by     *
+* the Free Software Foundation; either version 2 of the License, or        *
+* (at your option) any later version.                                      *
+*                                                                          *
+* This program is distributed in the hope that it will be useful,          *
+* but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             *
+* GNU General Public License for more details.                             *
+*                                                                          *
+* You should have received a copy of the GNU General Public License        *
+* along with this program; if not, write to the                            *
+* Free Software Foundation, Inc.,                                          *
+* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.                 *
+***************************************************************************/
 #include "numbernode.h"
 
 NumberNode::NumberNode()
diff --git a/node/numbernode.h b/node/numbernode.h
index f653595..3c43a51 100644
--- a/node/numbernode.h
+++ b/node/numbernode.h
@@ -1,9 +1,33 @@
+/***************************************************************************
+* Copyright (C) 2014 by Renaud Guezennec                                   *
+* http://renaudguezennec.homelinux.org/accueil,3.html                      *
+*                                                                          *
+*  This file is part of DiceParser                                         *
+*                                                                          *
+* DiceParser is free software; you can redistribute it and/or modify       *
+* it under the terms of the GNU General Public License as published by     *
+* the Free Software Foundation; either version 2 of the License, or        *
+* (at your option) any later version.                                      *
+*                                                                          *
+* This program is distributed in the hope that it will be useful,          *
+* but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             *
+* GNU General Public License for more details.                             *
+*                                                                          *
+* You should have received a copy of the GNU General Public License        *
+* along with this program; if not, write to the                            *
+* Free Software Foundation, Inc.,                                          *
+* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.                 *
+***************************************************************************/
 #ifndef NUMBERNODE_H
 #define NUMBERNODE_H
 
 #include "node/executionnode.h"
 #include "result/scalarresult.h"
 
+/**
+ * @brief The NumberNode class is an ExecutionNode. It is dedicated to store number.
+ */
 class NumberNode : public ExecutionNode
 {
 public:
diff --git a/node/parenthesesnode.cpp b/node/parenthesesnode.cpp
index f76d33c..2876147 100644
--- a/node/parenthesesnode.cpp
+++ b/node/parenthesesnode.cpp
@@ -1,3 +1,24 @@
+/***************************************************************************
+* Copyright (C) 2014 by Renaud Guezennec                                   *
+* http://renaudguezennec.homelinux.org/accueil,3.html                      *
+*                                                                          *
+*  This file is part of DiceParser                                         *
+*                                                                          *
+* DiceParser is free software; you can redistribute it and/or modify       *
+* it under the terms of the GNU General Public License as published by     *
+* the Free Software Foundation; either version 2 of the License, or        *
+* (at your option) any later version.                                      *
+*                                                                          *
+* This program is distributed in the hope that it will be useful,          *
+* but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             *
+* GNU General Public License for more details.                             *
+*                                                                          *
+* You should have received a copy of the GNU General Public License        *
+* along with this program; if not, write to the                            *
+* Free Software Foundation, Inc.,                                          *
+* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.                 *
+***************************************************************************/
 #include "parenthesesnode.h"
 
 ParenthesesNode::ParenthesesNode()
diff --git a/node/parenthesesnode.h b/node/parenthesesnode.h
index 9df3cdc..999e7bd 100644
--- a/node/parenthesesnode.h
+++ b/node/parenthesesnode.h
@@ -1,8 +1,32 @@
+/***************************************************************************
+* Copyright (C) 2014 by Renaud Guezennec                                   *
+* http://renaudguezennec.homelinux.org/accueil,3.html                      *
+*                                                                          *
+*  This file is part of DiceParser                                         *
+*                                                                          *
+* DiceParser is free software; you can redistribute it and/or modify       *
+* it under the terms of the GNU General Public License as published by     *
+* the Free Software Foundation; either version 2 of the License, or        *
+* (at your option) any later version.                                      *
+*                                                                          *
+* This program is distributed in the hope that it will be useful,          *
+* but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             *
+* GNU General Public License for more details.                             *
+*                                                                          *
+* You should have received a copy of the GNU General Public License        *
+* along with this program; if not, write to the                            *
+* Free Software Foundation, Inc.,                                          *
+* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.                 *
+***************************************************************************/
 #ifndef PARENTHESESNODE_H
 #define PARENTHESESNODE_H
 
 #include "executionnode.h"
-
+/**
+ * @brief The ParenthesesNode class is an ExecutionNode. It is dedicated to manage expression which was inside ParenthesesNode.
+ * It is acting just like an StartingNode by for an internal execution tree.
+ */
 class ParenthesesNode : public ExecutionNode
 {
 public:
diff --git a/node/sortresult.cpp b/node/sortresult.cpp
index deaf794..b3e6b49 100644
--- a/node/sortresult.cpp
+++ b/node/sortresult.cpp
@@ -1,3 +1,24 @@
+/***************************************************************************
+* Copyright (C) 2014 by Renaud Guezennec                                   *
+* http://renaudguezennec.homelinux.org/accueil,3.html                      *
+*                                                                          *
+*  This file is part of DiceParser                                         *
+*                                                                          *
+* DiceParser is free software; you can redistribute it and/or modify       *
+* it under the terms of the GNU General Public License as published by     *
+* the Free Software Foundation; either version 2 of the License, or        *
+* (at your option) any later version.                                      *
+*                                                                          *
+* This program is distributed in the hope that it will be useful,          *
+* but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             *
+* GNU General Public License for more details.                             *
+*                                                                          *
+* You should have received a copy of the GNU General Public License        *
+* along with this program; if not, write to the                            *
+* Free Software Foundation, Inc.,                                          *
+* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.                 *
+***************************************************************************/
 #include "sortresult.h"
 
 #include <QDebug>
@@ -25,7 +46,7 @@ void SortResultNode::run(ExecutionNode* node)
         QList<Die*> diceList2=m_diceResult->getResultList();
 
 
-        // Dichotomic sorting
+        // half-interval search sorting
         for(int i = 0; i<diceList.size();++i)
         {
             Die* tmp1 = diceList[i];
diff --git a/node/sortresult.h b/node/sortresult.h
index 8ce03a2..d505e4b 100644
--- a/node/sortresult.h
+++ b/node/sortresult.h
@@ -1,18 +1,59 @@
+/***************************************************************************
+* Copyright (C) 2014 by Renaud Guezennec                                   *
+* http://renaudguezennec.homelinux.org/accueil,3.html                      *
+*                                                                          *
+*  This file is part of DiceParser                                         *
+*                                                                          *
+* DiceParser is free software; you can redistribute it and/or modify       *
+* it under the terms of the GNU General Public License as published by     *
+* the Free Software Foundation; either version 2 of the License, or        *
+* (at your option) any later version.                                      *
+*                                                                          *
+* This program is distributed in the hope that it will be useful,          *
+* but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             *
+* GNU General Public License for more details.                             *
+*                                                                          *
+* You should have received a copy of the GNU General Public License        *
+* along with this program; if not, write to the                            *
+* Free Software Foundation, Inc.,                                          *
+* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.                 *
+***************************************************************************/
 #ifndef SORTRESULT_H
 #define SORTRESULT_H
 
 #include "executionnode.h"
 #include "result/diceresult.h"
-
+/**
+ * @brief The SortResultNode class is an ExecutionNode, and it is dedicated to sort dice list.
+ * The sort is made by hand, using half-interval search algorithm.
+ */
 class SortResultNode : public ExecutionNode
 {
 public:
+    /**
+     * @brief SortResultNode
+     */
     SortResultNode();
+    /**
+     * @brief run
+     */
     virtual void run(ExecutionNode*);
 
-
+    /**
+     * @brief setSortAscending
+     * @param asc
+     */
     void setSortAscending(bool asc);
+    /**
+     * @brief toString
+     * @return
+     */
     virtual QString toString()const;
+    /**
+     * @brief getPriority
+     * @return
+     */
     virtual qint64 getPriority() const;
 
 private:
diff --git a/node/startingnode.h b/node/startingnode.h
index ccb7c87..ebe28c0 100644
--- a/node/startingnode.h
+++ b/node/startingnode.h
@@ -3,13 +3,30 @@
 
 #include "executionnode.h"
 
+/**
+ * @brief The StartingNode class is an ExecutionNode, StartingNode is dedicated to be the first node
+ * in the execution tree.
+ */
 class StartingNode : public ExecutionNode
 {
 public:
+    /**
+     * @brief StartingNode
+     */
     StartingNode();
-
+    /**
+     * @brief run
+     */
     virtual void run(ExecutionNode*);
+    /**
+     * @brief toString
+     * @return
+     */
     virtual QString toString()const;
+    /**
+     * @brief getPriority
+     * @return
+     */
     virtual qint64 getPriority() const;
 };