summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@digia.com>2012-11-27 12:35:35 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-11-27 15:03:42 +0100
commit41f6f099a581fbad93129af1bf699d23dfe6a359 (patch)
tree3bd8513e87384bd74d1bef7eb67121e6a2b86baa
parent80a0227a57b62a30ec3fcac4e3d986cc97bc3ae4 (diff)
downloadqtscript-41f6f099a581fbad93129af1bf699d23dfe6a359.tar.gz
Updated the module overview
Mention the JS functionality in Qt Qml, and that Qt Qml can be an option for the commercial customers that can't use LGPL'ed code. Change-Id: Ibbefa160711820fb6235aa312a375e1b1b9d0b16 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com> Reviewed-by: Sami Makkonen <sami.makkonen@digia.com> Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
-rw-r--r--src/script/doc/src/qtscript.qdoc62
1 files changed, 36 insertions, 26 deletions
diff --git a/src/script/doc/src/qtscript.qdoc b/src/script/doc/src/qtscript.qdoc
index fc07ce8..bb09817 100644
--- a/src/script/doc/src/qtscript.qdoc
+++ b/src/script/doc/src/qtscript.qdoc
@@ -37,6 +37,11 @@
QtScriptTools module provides additional Qt Script-related
components that application developers may find useful.
+ This module is mainly provided for backwards compatibility reasons
+ with Qt 4.x and not being actively developed any further. For new
+ code please consider using the QJSEngine, etc. classes in the
+ Qt Qml module instead.
+
To include the definitions of the module's classes, use the
following directive:
@@ -46,39 +51,44 @@
\snippet code/doc_src_qtscript.pro 1
- For detailed information on how to make your application
- scriptable with QtScript, see \l{Making Applications
- Scriptable}.
+ For detailed information on how to make your application
+ scriptable with QtScript, see \l{Making Applications
+ Scriptable}.
+
+ \section1 License Information
- \section1 License Information
+ Qt Commercial Edition licensees that wish to distribute applications that
+ use the QtScript module need to be aware of their obligations under the
+ GNU Library General Public License (LGPL).
- Qt Commercial Edition licensees that wish to distribute applications that
- use the QtScript module need to be aware of their obligations under the
- GNU Library General Public License (LGPL).
+ Developers using the Open Source Edition can choose to redistribute
+ the module under the appropriate version of the GNU LGPL.
- Developers using the Open Source Edition can choose to redistribute
- the module under the appropriate version of the GNU LGPL.
+ Commercial customers that do not want to depend on LGPL code can
+ consider using the QJSEngine and QJSValue classes in the Qt Qml module.
+ These classes offer a similar but more narrow scripting API that is
+ sufficient for most use cases and is not dependent on LGPL code.
- \legalese
- QtScript is licensed under the GNU Library General Public License.
- Individual contributor names and copyright dates can be found
- inline in the code.
+ \legalese
+ QtScript is licensed under the GNU Library General Public License.
+ Individual contributor names and copyright dates can be found
+ inline in the code.
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
- This library 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
- Library General Public License for more details.
+ This library 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
+ Library General Public License for more details.
- You should have received a copy of the GNU Library General Public License
- along with this library; see the file COPYING.LIB. If not, write to
- the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
- \endlegalese
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+ \endlegalese
*/