summaryrefslogtreecommitdiffstats
path: root/src/libs/installer/scriptengine.cpp
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-01-30 13:50:47 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-01-30 14:47:33 +0000
commitd7bdbb1b3a49873ab8feae16d4e1a9ae09bf17b5 (patch)
tree7e8f1fd9ee084f98d5df744cd115032f223338e7 /src/libs/installer/scriptengine.cpp
parent93a10096f82b9a187fc5bf31a65394033696fb72 (diff)
Doc: add docs for arguments and return values
To get rid of QDoc errors. Change-Id: I4932f1f3ff5fab87eebf24536d63be550582b195 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Diffstat (limited to 'src/libs/installer/scriptengine.cpp')
-rw-r--r--src/libs/installer/scriptengine.cpp7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/libs/installer/scriptengine.cpp b/src/libs/installer/scriptengine.cpp
index 6a6a18fd8..057ce9c85 100644
--- a/src/libs/installer/scriptengine.cpp
+++ b/src/libs/installer/scriptengine.cpp
@@ -682,12 +682,13 @@ QJSValue ScriptEngine::loadInContext(const QString &context, const QString &file
}
/*!
- Tries to call the method with \a name within the script and returns the result. If the method
- doesn't exist or is not callable, an undefined result is returned. If the call to the method
+ Tries to call the method specified by \a methodName with the arguments specified by
+ \a arguments within the script and returns the result. If the method does not exist or
+ is not callable, an undefined result is returned. If the call to the method
succeeds and the return value is still undefined, a null value will be returned instead.
If the method call has an exception, its string representation is thrown as an Error exception.
- \note The method is not called, if the current script context is the same method, to avoid
+ \note The method is not called if \a scriptContext is the same method, to avoid
infinite recursion.
*/
QJSValue ScriptEngine::callScriptMethod(const QJSValue &scriptContext, const QString &methodName,