aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/result
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2015-04-30 11:09:04 +0200
committerRenaud G <renaud@rolisteam.org>2015-04-30 11:09:04 +0200
commite1429844d3c7c2feeec8291084fb7f36e9ef38af (patch)
tree352d0bcac94201727e75ae55c0ba0da5d1aaf7cb /result
parent5c73a6cb13b8c301d0e60f916998c3e683a2b043 (diff)
downloadOneRoll-e1429844d3c7c2feeec8291084fb7f36e9ef38af.tar.gz
OneRoll-e1429844d3c7c2feeec8291084fb7f36e9ef38af.zip
add comments and gpl header to those files for better documentation in doxygen
Diffstat (limited to 'result')
-rw-r--r--result/scalarresult.h22
1 files changed, 18 insertions, 4 deletions
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 <Qt>
-
+/**
+ * @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: