From e1429844d3c7c2feeec8291084fb7f36e9ef38af Mon Sep 17 00:00:00 2001 From: Renaud G Date: Thu, 30 Apr 2015 11:09:04 +0200 Subject: add comments and gpl header to those files for better documentation in doxygen --- diceparser.h | 2 +- node/numbernode.cpp | 21 +++++++++++++++++++++ node/numbernode.h | 24 ++++++++++++++++++++++++ node/parenthesesnode.cpp | 21 +++++++++++++++++++++ node/parenthesesnode.h | 26 +++++++++++++++++++++++++- node/sortresult.cpp | 23 ++++++++++++++++++++++- node/sortresult.h | 45 +++++++++++++++++++++++++++++++++++++++++++-- node/startingnode.h | 19 ++++++++++++++++++- parsingtoolbox.h | 3 ++- range.h | 3 +++ result/scalarresult.h | 22 ++++++++++++++++++---- validator.h | 25 +++++++++++++++++++++++-- 12 files changed, 221 insertions(+), 13 deletions(-) diff --git a/diceparser.h b/diceparser.h index 93c5c2e..717630e 100644 --- a/diceparser.h +++ b/diceparser.h @@ -41,7 +41,7 @@ typedef QMap ExportedDiceResult; class ExploseDiceNode; /** - * @mainpage DiceParser + * @page DiceParser * * The grammar is something like this: * 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 @@ -25,7 +46,7 @@ void SortResultNode::run(ExecutionNode* node) QList diceList2=m_diceResult->getResultList(); - // Dichotomic sorting + // half-interval search sorting for(int i = 0; i #include "validator.h" +/** + * @brief The Range class is validator class to check validity between two values. + */ class Range : public Validator { public: diff --git a/result/scalarresult.h b/result/scalarresult.h index 4d64a90..8a0fa11 100644 --- a/result/scalarresult.h +++ b/result/scalarresult.h @@ -25,16 +25,30 @@ #include "result.h" #include - +/** + * @brief The ScalarResult class is used to store scalar result by many ExecutionNode. + */ class ScalarResult : public Result { public: + /** + * @brief ScalarResult + */ ScalarResult(); - + /** + * @brief getResult + * @return + */ virtual QVariant getResult(Result::RESULT_TYPE); - + /** + * @brief setValue + * @param i + */ void setValue(qreal i); - + /** + * @brief toString + * @return + */ virtual QString toString(); private: diff --git a/validator.h b/validator.h index d18a691..6dd8292 100644 --- a/validator.h +++ b/validator.h @@ -25,14 +25,35 @@ #include #include "die.h" #include - +/** + * @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 ; }; -- cgit v1.2.3-70-g09d2