From a11f72ea71e8fc390ff15307eb393ffcd6e12147 Mon Sep 17 00:00:00 2001 From: Renaud G Date: Mon, 19 Dec 2016 10:38:32 +0100 Subject: Update diceparser.h Add comments --- diceparser.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/diceparser.h b/diceparser.h index fb56685..0bc32e8 100644 --- a/diceparser.h +++ b/diceparser.h @@ -207,8 +207,18 @@ public: * @return */ QStringList getAllDiceResult(bool& hasAlias); - + /** + * @brief hasSeparator allows to know if the current command has separator. + * @return true when the command has separator, false otherwise. + */ bool hasSeparator()const; + /** + * @brief readIfInstruction reads the current command to build if node with proper parameters. + * @param str is the command string, if IF istruction is found, the str will be changed, in other case the string is unmodified + * @param trueNode is the branch's beginning to be executed if the IfNode is true. + * @param falseNode is the branch's beginning to be executed if the IfNode is false. + * @return true, ifNode has been found, false otherwise + */ bool readIfInstruction(QString &str, ExecutionNode* &trueNode, ExecutionNode* &falseNode); /** * @brief setVariableDictionary -- cgit v1.2.3-70-g09d2