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 --- 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 ++++++++++++++++++- 7 files changed, 174 insertions(+), 5 deletions(-) (limited to 'node') 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