From 7c8debaf726d26d68c940abdc5538f550accba0b Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Mon, 3 Dec 2012 15:52:47 +0100 Subject: Doc: Changed link in qdocconf file to point to landing page. -affects the QCH file. Change-Id: I05d38a4bdeca359ff6f58c434e6d61198487d2a5 Reviewed-by: Kai Koehne --- src/script/doc/qtscript.qdocconf | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'src/script/doc') diff --git a/src/script/doc/qtscript.qdocconf b/src/script/doc/qtscript.qdocconf index d07e15a..021224d 100644 --- a/src/script/doc/qtscript.qdocconf +++ b/src/script/doc/qtscript.qdocconf @@ -36,11 +36,12 @@ qhp.qtscript.namespace = org.qt-project.qtscript.500 # Title for the package, will be the main title for the package in # Assistant/Creator. -qhp.qtscript.indexTitle = Qt Script Documentation +qhp.qtscript.indexTitle = Qt Script # Only update the name of the project for the next variables. qhp.qtscript.virtualFolder = qtscript qhp.qtscript.subprojects = classes -qhp.qtscript.subprojects.classes.title = Qt Script C++ Classes +qhp.qtscript.subprojects.classes.title = C++ Classes +qhp.qtscript.subprojects.classes.indexTitle = Qt Script C++ Classes qhp.qtscript.subprojects.classes.selectors = class fake:headerfile qhp.qtscript.subprojects.classes.sortPages = true -- cgit v1.2.1 From 84db747e781ef3ea99e492ef8df572f9848c5307 Mon Sep 17 00:00:00 2001 From: David Schulz Date: Tue, 4 Dec 2012 15:37:59 +0100 Subject: QtScript: Fix link to Qt Linguist Manual. Change-Id: I543eee28fa1f72d2b9371b39906fd3f0219cc000 Reviewed-by: Leena Miettinen --- src/script/doc/qtscript.qdocconf | 2 +- src/script/doc/src/qtscript-index.qdoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'src/script/doc') diff --git a/src/script/doc/qtscript.qdocconf b/src/script/doc/qtscript.qdocconf index 021224d..382e09d 100644 --- a/src/script/doc/qtscript.qdocconf +++ b/src/script/doc/qtscript.qdocconf @@ -16,7 +16,7 @@ headerdirs += .. imagedirs += images sourcedirs += .. -depends += qtcore +depends += qtcore qtlinguist # The following parameters are for creating a qhp file, the qhelpgenerator # program can convert the qhp file into a qch file which can be opened in diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc index aabf584..15e7c30 100644 --- a/src/script/doc/src/qtscript-index.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -1723,7 +1723,7 @@ Once you are using qsTr() and/or qsTranslate() throughout your scripts, you can start producing translations of the user-visible text in your program. - The \l{Qt Linguist manual} provides further information about + The \l{Qt Linguist Manual} provides further information about Qt's translation tools, \e{Qt Linguist}, \c lupdate and \c lrelease. -- cgit v1.2.1 From 3f960df4c25b7e4e7d6aeaeecc62a083f8491b48 Mon Sep 17 00:00:00 2001 From: Sergio Ahumada Date: Wed, 2 Jan 2013 12:57:45 +0100 Subject: Update copyright year in Digia's license headers Change-Id: Ic4a2739c8caf2eac95e4a72d8d38cfb912d5fe2b Reviewed-by: Akseli Salovaara Reviewed-by: Sergio Ahumada --- src/script/doc/snippets/code/doc_src_qtscript.cpp | 2 +- src/script/doc/snippets/code/doc_src_qtscript.js | 2 +- src/script/doc/snippets/code/doc_src_qtscript.pro | 2 +- src/script/doc/snippets/code/doc_src_qtscript.qdoc | 2 +- src/script/doc/snippets/code/doc_src_qtscriptextensions.js | 2 +- src/script/doc/snippets/code/src_script_qscriptable.cpp | 2 +- src/script/doc/snippets/code/src_script_qscriptclass.cpp | 2 +- src/script/doc/snippets/code/src_script_qscriptcontext.cpp | 2 +- src/script/doc/snippets/code/src_script_qscriptengine.cpp | 2 +- src/script/doc/snippets/code/src_script_qscriptengineagent.cpp | 2 +- src/script/doc/snippets/code/src_script_qscriptvalue.cpp | 2 +- src/script/doc/snippets/code/src_script_qscriptvalueiterator.cpp | 2 +- src/script/doc/snippets/qtscript/evaluation/main.cpp | 2 +- src/script/doc/snippets/qtscript/registeringobjects/main.cpp | 2 +- src/script/doc/snippets/qtscript/registeringvalues/main.cpp | 2 +- src/script/doc/src/ecmascript.qdoc | 2 +- src/script/doc/src/external-resources.qdoc | 2 +- src/script/doc/src/qtscript-index.qdoc | 2 +- src/script/doc/src/qtscript-module.qdoc | 2 +- src/script/doc/src/qtscriptdebugger-manual.qdoc | 2 +- src/script/doc/src/qtscriptextensions.qdoc | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) (limited to 'src/script/doc') diff --git a/src/script/doc/snippets/code/doc_src_qtscript.cpp b/src/script/doc/snippets/code/doc_src_qtscript.cpp index 3e4cb04..bb58400 100644 --- a/src/script/doc/snippets/code/doc_src_qtscript.cpp +++ b/src/script/doc/snippets/code/doc_src_qtscript.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/doc_src_qtscript.js b/src/script/doc/snippets/code/doc_src_qtscript.js index 98995f1..155cda1 100644 --- a/src/script/doc/snippets/code/doc_src_qtscript.js +++ b/src/script/doc/snippets/code/doc_src_qtscript.js @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/doc_src_qtscript.pro b/src/script/doc/snippets/code/doc_src_qtscript.pro index b68aa31..698ed00 100644 --- a/src/script/doc/snippets/code/doc_src_qtscript.pro +++ b/src/script/doc/snippets/code/doc_src_qtscript.pro @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/doc_src_qtscript.qdoc b/src/script/doc/snippets/code/doc_src_qtscript.qdoc index c66e553..5dcad87 100644 --- a/src/script/doc/snippets/code/doc_src_qtscript.qdoc +++ b/src/script/doc/snippets/code/doc_src_qtscript.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/doc_src_qtscriptextensions.js b/src/script/doc/snippets/code/doc_src_qtscriptextensions.js index 915733f..fa36087 100644 --- a/src/script/doc/snippets/code/doc_src_qtscriptextensions.js +++ b/src/script/doc/snippets/code/doc_src_qtscriptextensions.js @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/src_script_qscriptable.cpp b/src/script/doc/snippets/code/src_script_qscriptable.cpp index 9f14b15..9c8d1ae 100644 --- a/src/script/doc/snippets/code/src_script_qscriptable.cpp +++ b/src/script/doc/snippets/code/src_script_qscriptable.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/src_script_qscriptclass.cpp b/src/script/doc/snippets/code/src_script_qscriptclass.cpp index 32ac221..cd4b090 100644 --- a/src/script/doc/snippets/code/src_script_qscriptclass.cpp +++ b/src/script/doc/snippets/code/src_script_qscriptclass.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/src_script_qscriptcontext.cpp b/src/script/doc/snippets/code/src_script_qscriptcontext.cpp index 5365989..ba888a2 100644 --- a/src/script/doc/snippets/code/src_script_qscriptcontext.cpp +++ b/src/script/doc/snippets/code/src_script_qscriptcontext.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/src_script_qscriptengine.cpp b/src/script/doc/snippets/code/src_script_qscriptengine.cpp index 8bc53e3..7128410 100644 --- a/src/script/doc/snippets/code/src_script_qscriptengine.cpp +++ b/src/script/doc/snippets/code/src_script_qscriptengine.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/src_script_qscriptengineagent.cpp b/src/script/doc/snippets/code/src_script_qscriptengineagent.cpp index 7e95b30..8c46c05 100644 --- a/src/script/doc/snippets/code/src_script_qscriptengineagent.cpp +++ b/src/script/doc/snippets/code/src_script_qscriptengineagent.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/src_script_qscriptvalue.cpp b/src/script/doc/snippets/code/src_script_qscriptvalue.cpp index 84d025b..2f780af 100644 --- a/src/script/doc/snippets/code/src_script_qscriptvalue.cpp +++ b/src/script/doc/snippets/code/src_script_qscriptvalue.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/code/src_script_qscriptvalueiterator.cpp b/src/script/doc/snippets/code/src_script_qscriptvalueiterator.cpp index a00637a..7333d01 100644 --- a/src/script/doc/snippets/code/src_script_qscriptvalueiterator.cpp +++ b/src/script/doc/snippets/code/src_script_qscriptvalueiterator.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/qtscript/evaluation/main.cpp b/src/script/doc/snippets/qtscript/evaluation/main.cpp index e82756d..7001a37 100644 --- a/src/script/doc/snippets/qtscript/evaluation/main.cpp +++ b/src/script/doc/snippets/qtscript/evaluation/main.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/qtscript/registeringobjects/main.cpp b/src/script/doc/snippets/qtscript/registeringobjects/main.cpp index 3b089bd..0176251 100644 --- a/src/script/doc/snippets/qtscript/registeringobjects/main.cpp +++ b/src/script/doc/snippets/qtscript/registeringobjects/main.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/snippets/qtscript/registeringvalues/main.cpp b/src/script/doc/snippets/qtscript/registeringvalues/main.cpp index 6549f1a..c5d0af8 100644 --- a/src/script/doc/snippets/qtscript/registeringvalues/main.cpp +++ b/src/script/doc/snippets/qtscript/registeringvalues/main.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/src/ecmascript.qdoc b/src/script/doc/src/ecmascript.qdoc index eed0d48..c4b8797 100644 --- a/src/script/doc/src/ecmascript.qdoc +++ b/src/script/doc/src/ecmascript.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/src/external-resources.qdoc b/src/script/doc/src/external-resources.qdoc index 885a8e0..cb6af34 100644 --- a/src/script/doc/src/external-resources.qdoc +++ b/src/script/doc/src/external-resources.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc index 15e7c30..05005e9 100644 --- a/src/script/doc/src/qtscript-index.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/src/qtscript-module.qdoc b/src/script/doc/src/qtscript-module.qdoc index bb09817..675b759 100644 --- a/src/script/doc/src/qtscript-module.qdoc +++ b/src/script/doc/src/qtscript-module.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/src/qtscriptdebugger-manual.qdoc b/src/script/doc/src/qtscriptdebugger-manual.qdoc index ad8bd80..fbad2ed 100644 --- a/src/script/doc/src/qtscriptdebugger-manual.qdoc +++ b/src/script/doc/src/qtscriptdebugger-manual.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/script/doc/src/qtscriptextensions.qdoc b/src/script/doc/src/qtscriptextensions.qdoc index d8f37e3..2a7c27e 100644 --- a/src/script/doc/src/qtscriptextensions.qdoc +++ b/src/script/doc/src/qtscriptextensions.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. -- cgit v1.2.1 From c648313b1eb5dada1839d85e166d5288ceb3af2f Mon Sep 17 00:00:00 2001 From: Sergio Ahumada Date: Sat, 12 Jan 2013 09:14:13 +0100 Subject: doc: Fix namespace version to 5.0.1 for qhp documentation Change-Id: I7f7eec61e442831b82aed579dd1526a12ebd71c8 Reviewed-by: hjk --- src/script/doc/qtscript.qdocconf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/script/doc') diff --git a/src/script/doc/qtscript.qdocconf b/src/script/doc/qtscript.qdocconf index 382e09d..0e6d58f 100644 --- a/src/script/doc/qtscript.qdocconf +++ b/src/script/doc/qtscript.qdocconf @@ -32,7 +32,7 @@ qhp.qtscript.file = qtscript.qhp # Namespace for the output file. This namespace is used to distinguish between # different documentation files in Creator/Assistant. -qhp.qtscript.namespace = org.qt-project.qtscript.500 +qhp.qtscript.namespace = org.qt-project.qtscript.501 # Title for the package, will be the main title for the package in # Assistant/Creator. -- cgit v1.2.1 From 8759cf3fcb3b78a7b62e7f4feedee8e6822bde32 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Tue, 22 Jan 2013 18:00:26 +0100 Subject: Doc: Modularized Qt Script Tools documentation. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit -moved content from qtdoc -moved snippets to src/scripttools -enabled 'make docs' -edited QScriptEngineDebugger with the proper module identifier -created two way links from Qt Script to Qt Script Tools Change-Id: I83a76278969528dcb1ecbca4acc8563fe9390978 Reviewed-by: Jędrzej Nowacki Reviewed-by: Geir Vattekar --- src/script/doc/qtscript.qdocconf | 2 +- src/script/doc/src/qtscript-index.qdoc | 3 +-- src/script/doc/src/qtscriptdebugger-manual.qdoc | 10 +++++----- 3 files changed, 7 insertions(+), 8 deletions(-) (limited to 'src/script/doc') diff --git a/src/script/doc/qtscript.qdocconf b/src/script/doc/qtscript.qdocconf index 0e6d58f..7f8d37c 100644 --- a/src/script/doc/qtscript.qdocconf +++ b/src/script/doc/qtscript.qdocconf @@ -16,7 +16,7 @@ headerdirs += .. imagedirs += images sourcedirs += .. -depends += qtcore qtlinguist +depends += qtcore qtlinguist qtscripttools # The following parameters are for creating a qhp file, the qhelpgenerator # program can convert the qhp file into a qch file which can be opened in diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc index 15e7c30..4399d2e 100644 --- a/src/script/doc/src/qtscript-index.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -1637,7 +1637,7 @@ doesn't provide any debugging-specific functionality (e.g. setting breakpoints), but it is the basis of tools that do. - The QScriptEngineDebugger class introduced in Qt 4.5 provides a + The \l{Qt Script Tools} module provides a \l{Qt Script Debugger Manual}{Qt Script debugger} that can be embedded into your application. @@ -1876,4 +1876,3 @@ \brief Classes that add scripting capabilities to Qt applications. */ - diff --git a/src/script/doc/src/qtscriptdebugger-manual.qdoc b/src/script/doc/src/qtscriptdebugger-manual.qdoc index ad8bd80..4e12e27 100644 --- a/src/script/doc/src/qtscriptdebugger-manual.qdoc +++ b/src/script/doc/src/qtscriptdebugger-manual.qdoc @@ -30,8 +30,8 @@ \title Qt Script Debugger Manual \brief A manual describing how to use the Qt Script debugger. - The Qt Script debugger is a tool for debugging script execution in - Qt applications that use Qt Script. Application developers can embed + The \l{Qt Script Tools} module provides a debugger for script execution in + Qt applications that use \l{Qt Script}. Application developers can embed the debugger into their application through the QScriptEngineDebugger class. This manual describes how to use the debugger. We assume that the reader is somewhat familiar with @@ -291,7 +291,7 @@ previously. \section3 ignore - + Sets the ignore-count of a breakpoint, i.e., the breakpoint will not stop the program execution unless it have been reached \c count times. This can, for instance, be useful in loops to stop at a @@ -356,7 +356,7 @@ \section3 eval - Evaluates a program. + Evaluates a program. \section3 finish @@ -402,7 +402,7 @@ Selects the previous (inner) stack frame. The execution will not return to this frame, but you will get access to its local - variables. + variables. \section3 frame -- cgit v1.2.1 From 19550797aa16ee60fc19fdaf90832b4895612226 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Fri, 25 Jan 2013 20:40:36 +0800 Subject: Doc: Fix module name format Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtScript -> Qt Script QtScriptTools -> Qt Script Tools Change-Id: Icf6b2ea3829247475f8902334b615f9a9206cc51 Reviewed-by: Jerome Pasion --- src/script/doc/snippets/code/doc_src_qtscript.cpp | 6 +- src/script/doc/src/ecmascript.qdoc | 4 +- src/script/doc/src/qtscript-index.qdoc | 88 +++++++++++------------ src/script/doc/src/qtscript-module.qdoc | 12 ++-- src/script/doc/src/qtscriptextensions.qdoc | 6 +- 5 files changed, 58 insertions(+), 58 deletions(-) (limited to 'src/script/doc') diff --git a/src/script/doc/snippets/code/doc_src_qtscript.cpp b/src/script/doc/snippets/code/doc_src_qtscript.cpp index bb58400..6cbb5de 100644 --- a/src/script/doc/snippets/code/doc_src_qtscript.cpp +++ b/src/script/doc/snippets/code/doc_src_qtscript.cpp @@ -65,7 +65,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; @@ -103,7 +103,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; @@ -132,7 +132,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; diff --git a/src/script/doc/src/ecmascript.qdoc b/src/script/doc/src/ecmascript.qdoc index c4b8797..84116c7 100644 --- a/src/script/doc/src/ecmascript.qdoc +++ b/src/script/doc/src/ecmascript.qdoc @@ -28,10 +28,10 @@ /*! \page ecmascript.html \title ECMAScript Reference - \brief A list of objects, functions and properties supported by QtScript. + \brief A list of objects, functions and properties supported by Qt Script. This reference contains a list of built-in objects, functions and - properties supported by QtScript. For a detailed description, see + properties supported by Qt Script. For a detailed description, see the \l{ECMA-262} specification. \tableofcontents diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc index 05005e9..7e5af4c 100644 --- a/src/script/doc/src/qtscript-index.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -182,7 +182,7 @@ When the argument is a QObject slot, the argument types of the signal and slot do not necessarily have to be compatible; - QtScript will, if necessary, perform conversion of the signal + Qt Script will, if necessary, perform conversion of the signal arguments to match the argument types of the slot. To disconnect from a signal, you invoke the signal's @@ -254,7 +254,7 @@ \section3 Overloaded Signals and Slots - When a signal or slot is overloaded, QtScript will attempt to + When a signal or slot is overloaded, Qt Script will attempt to pick the right overload based on the actual types of the QScriptValue arguments involved in the function invocation. For example, if your class has slots \c{myOverloadedSlot(int)} and \c{myOverloadedSlot(QString)}, the following @@ -268,7 +268,7 @@ \snippet code/doc_src_qtscript.js 12 - If the overloads have different number of arguments, QtScript will + If the overloads have different number of arguments, Qt Script will pick the overload with the argument count that best matches the actual number of arguments passed to the slot. @@ -279,7 +279,7 @@ \section2 Accessing Properties The properties of the QObject are available as properties - of the corresponding QtScript object. When you manipulate + of the corresponding Qt Script object. When you manipulate a property in script code, the C++ get/set method for that property will automatically be invoked. For example, if your C++ class has a property declared as follows: @@ -294,7 +294,7 @@ Every named child of the QObject (that is, for which QObject::objectName() is not an empty string) is by default available as - a property of the QtScript wrapper object. For example, + a property of the Qt Script wrapper object. For example, if you have a QDialog with a child widget whose \c{objectName} property is \c{"okButton"}, you can access this object in script code through the expression @@ -366,7 +366,7 @@ With QScriptEngine::AutoOwnership the ownership is based on whether the QObject has a parent or not. - If the QtScript garbage collector finds that the QObject is no + If the Qt Script garbage collector finds that the QObject is no longer referenced within the script environment, the QObject will be deleted \e{only} if it does not have a parent. @@ -390,7 +390,7 @@ QScriptEngine::newQObject() can take a third argument which allows you to control various aspects of the access to the QObject through - the QtScript wrapper object it returns. + the Qt Script wrapper object it returns. QScriptEngine::ExcludeChildObjects specifies that child objects of the QObject should not appear as properties of the wrapper object. @@ -405,7 +405,7 @@ QScriptEngine::AutoCreateDynamicProperties specifies that properties that don't already exist in the QObject should be created as dynamic - properties of the QObject, rather than as properties of the QtScript + properties of the QObject, rather than as properties of the Qt Script wrapper object. If you want new properties to truly become persistent properties of the QObject, rather than properties that are destroyed along with the wrapper object (and that aren't shared if the QObject @@ -442,14 +442,14 @@ properties of the QMetaObject wrapper object that can be created with QScriptEngine::newQMetaObject(). - \section1 Conversion Between QtScript and C++ Types + \section1 Conversion Between Qt Script and C++ Types - QtScript will perform type conversion when a value needs to be + Qt Script will perform type conversion when a value needs to be converted from the script side to the C++ side or vice versa; for instance, when a C++ signal triggers a script function, when you access a QObject property in script code, or when you call QScriptEngine::toScriptValue() or - QScriptEngine::fromScriptValue() in C++. QtScript provides default + QScriptEngine::fromScriptValue() in C++. Qt Script provides default conversion operations for many of the built-in Qt types. You can change the conversion operation for a type (including your custom C++ types) by registering your own conversion functions with @@ -511,7 +511,7 @@ the result is an empty QList. \endtable - Additionally, QtScript will handle the following cases: + Additionally, Qt Script will handle the following cases: \list \li If the QScriptValue is a QObject and the target type name ends with @@ -592,7 +592,7 @@ This section explains how to implement application objects and provides the necessary technical background material. - \section2 Making a C++ object available to Scripts Written in QtScript + \section2 Making a C++ object available to Scripts Written in Qt Script Making C++ classes and objects available to a scripting language is not trivial because scripting languages tend to be more dynamic than @@ -608,7 +608,7 @@ (Meta-Object Compiler). Classes that wish to take advantage of the meta-object facilities are either subclasses of QObject, or use the \c{Q_OBJECT} macro. Qt has used this approach for many years and it has - proven to be solid and reliable. QtScript uses this meta-object + proven to be solid and reliable. Qt Script uses this meta-object technology to provide scripters with dynamic access to C++ classes and objects. @@ -619,14 +619,14 @@ how to implement application objects. However, this knowledge is not essential in the simplest cases. - To make an object available in QtScript, it must derive from + To make an object available in Qt Script, it must derive from QObject. All classes which derive from QObject can be introspected and can provide the information needed by the scripting engine at run-time; e.g., class name, functions, signatures. Because we obtain the information we need about classes dynamically at run-time, there is no need to write wrappers for QObject derived classes. - \section2 Making C++ Class Member Functions Available in QtScript + \section2 Making C++ Class Member Functions Available in Qt Script The meta-object system also makes information about signals and slots dynamically available at run-time. By default, for QObject subclasses, @@ -634,7 +634,7 @@ This is very convenient because, in practice, we normally only want to make specially chosen functions available to scripters. When you create a QObject subclass, make sure that the functions you want to expose to - QtScript are public slots. + Qt Script are public slots. For example, the following class definition enables scripting only for certain functions: @@ -642,8 +642,8 @@ \snippet code/doc_src_qtscript.cpp 19 In the example above, aNonScriptableFunction() is not declared as a - slot, so it will not be available in QtScript. The other three - functions will automatically be made available in QtScript because + slot, so it will not be available in Qt Script. The other three + functions will automatically be made available in Qt Script because they are declared in the \c{public slots} section of the class definition. @@ -653,7 +653,7 @@ \snippet code/doc_src_qtscript.cpp 20 Once declared with \c{Q_INVOKABLE}, the method can be invoked from - QtScript code just as if it were a slot. Although such a method is + Qt Script code just as if it were a slot. Although such a method is not a slot, you can still specify it as the target function in a call to \c{connect()} in script code; \c{connect()} accepts both native and non-native functions as targets. @@ -664,10 +664,10 @@ to supply conversion functions. This is done using the qScriptRegisterMetaType() function. - \section2 Making C++ Class Properties Available in QtScript + \section2 Making C++ Class Properties Available in Qt Script In the previous example, if we wanted to get or set a property using - QtScript we would have to write code like the following: + Qt Script we would have to write code like the following: \snippet code/doc_src_qtscript.js 21 @@ -691,7 +691,7 @@ the names of the setter and getter functions as arguments. If you don't want a property of your class to be accessible in - QtScript, you set the \c{SCRIPTABLE} attribute to \c false when + Qt Script, you set the \c{SCRIPTABLE} attribute to \c false when declaring the property; by default, the \c{SCRIPTABLE} attribute is \c true. For example: @@ -705,10 +705,10 @@ is called. This connection is established using the QObject::connect() function. - The signals and slots mechanism is also available to QtScript + The signals and slots mechanism is also available to Qt Script programmers. The code to declare a signal in C++ is the same, regardless of whether the signal will be connected to a slot in C++ - or in QtScript. + or in Qt Script. \snippet code/doc_src_qtscript.cpp 25 @@ -722,9 +722,9 @@ \section2 Design of Application Objects The previous section described how to implement C++ objects which - can be used in QtScript. Application objects are the same kind of + can be used in Qt Script. Application objects are the same kind of objects, and they make your application's functionality available to - QtScript scripters. Since the C++ application is already written + Qt Script scripters. Since the C++ application is already written in Qt, many objects are already QObjects. The easiest approach would be to simply add all these QObjects as application objects to the scripting engine. For small applications this might be sufficient, @@ -747,7 +747,7 @@ If you have a slot that returns a QObject pointer, you should note that, by default, Qt Script only handles conversion of the types QObject* and QWidget*. This means that if your slot is declared - with a signature like "MyObject* getMyObject()", QtScript doesn't + with a signature like "MyObject* getMyObject()", Qt Script doesn't automatically know that MyObject* should be handled in the same way as QObject* and QWidget*. The simplest way to solve this is to only use QObject* and QWidget* in the method signatures of your scripting @@ -1285,10 +1285,10 @@ In ECMAScript, inheritance is based on the concept of \e{shared prototype objects}; this is quite different from the class-based - inheritance familiar to C++ programmers. With QtScript, you can + inheritance familiar to C++ programmers. With Qt Script, you can associate a custom prototype object with a C++ type using QScriptEngine::setDefaultPrototype(); this is the key to providing - a script interface to that type. Since the QtScript module is built + a script interface to that type. Since the Qt Script module is built on top of Qt's meta-type system, this can be done for any C++ type. You might be wondering when exactly you would need to use this @@ -1314,25 +1314,25 @@ This section explains the underlying concepts of prototype-based inheritance. Once these concepts are understood, the associated - practices can be applied throughout the QtScript API in order to + practices can be applied throughout the Qt Script API in order to create well-behaved, consistent bindings to C++ that will fit nicely into the ECMAScript universe. - When experimenting with QtScript objects and inheritance, it can be + When experimenting with Qt Script objects and inheritance, it can be helpful to use the interactive interpreter included with the \l{Qt Script Examples}, located in \c{examples/script/qscript}. \section2 Prototype Objects and Shared Properties - The purpose of a QtScript \e{prototype object} is to define - behavior that should be shared by a set of other QtScript + The purpose of a Qt Script \e{prototype object} is to define + behavior that should be shared by a set of other Qt Script objects. We say that objects which share the same prototype object belong to the same \e{class} (again, on the technical side this should not to be confused with the class constructs of languages like C++ and Java; ECMAScript has no such construct). The basic prototype-based inheritance mechanism works as follows: Each - QtScript object has an internal link to another object, its + Qt Script object has an internal link to another object, its \e{prototype}. When a property is looked up in an object, and the object itself does not have the property, the property is looked up in the prototype object instead; if the prototype has the property, @@ -1365,7 +1365,7 @@ \section2 Defining Classes in a Prototype-Based Universe - In QtScript, a class is not defined explicitly; there is no + In Qt Script, a class is not defined explicitly; there is no \c{class} keyword. Instead, you define a new class in two steps: \list 1 @@ -1393,10 +1393,10 @@ Next, you want to set up \c{Person.prototype} as your prototype object; i.e., define the interface that should be common to all - \c{Person} objects. QtScript automatically creates a default + \c{Person} objects. Qt Script automatically creates a default prototype object (by the expression \c{new Object()}) for every script function; you can add properties to this object, or you can - assign your own custom object. (Generally speaking, any QtScript + assign your own custom object. (Generally speaking, any Qt Script object can act as prototype for any other object.) Here's an example of how you might want to override the @@ -1445,7 +1445,7 @@ same as that of \c{Person} objects, but with \c{Employee.prototype} added to the front of the chain. - \section2 Prototype-Based Programming with the QtScript C++ API + \section2 Prototype-Based Programming with the Qt Script C++ API You can use QScriptEngine::newFunction() to wrap native functions. When implementing a constructor function, @@ -1472,7 +1472,7 @@ You associate a prototype object with a C++ type by calling QScriptEngine::setDefaultPrototype(). Once this mapping is - established, QtScript will automatically assign the correct + established, Qt Script will automatically assign the correct prototype when a value of such a type is wrapped in a QScriptValue; either when you explicitly call QScriptEngine::toScriptValue(), or when a value of such a type is returned from a C++ slot and @@ -1661,7 +1661,7 @@ of the script function itself, so that it can be retrieved when the function is called. - \section1 Using QtScript Extensions + \section1 Using Qt Script Extensions The QScriptEngine::importExtension() function can be used to load plugins into a script engine. Plugins typically add some extra functionality to @@ -1670,7 +1670,7 @@ scripts. There are currently no script plugins shipped with Qt. If you are implementing some Qt Script functionality that you want other - Qt application developers to be able to use, \l{Creating QtScript Extensions} + Qt application developers to be able to use, \l{Creating Qt Script Extensions} {developing an extension} (e.g. by subclassing QScriptExtensionPlugin) is worth looking into. @@ -1798,11 +1798,11 @@ \section1 ECMAScript Compatibility - QtScript implements all the built-in objects and properties defined + Qt Script implements all the built-in objects and properties defined in the \l{ECMA-262} standard; see the \l{ECMAScript Reference}{ECMAScript reference} for an overview. - \section1 QtScript Extensions to ECMAScript + \section1 Qt Script Extensions to ECMAScript \list \li \c{__proto__} \br diff --git a/src/script/doc/src/qtscript-module.qdoc b/src/script/doc/src/qtscript-module.qdoc index 675b759..5f19fd9 100644 --- a/src/script/doc/src/qtscript-module.qdoc +++ b/src/script/doc/src/qtscript-module.qdoc @@ -31,10 +31,10 @@ \since 4.3 \ingroup modules - \brief The QtScript module provides classes for making Qt applications scriptable. + \brief The Qt Script module provides classes for making Qt applications scriptable. - The QtScript module only provides core scripting facilities; the - QtScriptTools module provides additional Qt Script-related + The Qt Script module only provides core scripting facilities; the + Qt Script Tools module provides additional Qt Script-related components that application developers may find useful. This module is mainly provided for backwards compatibility reasons @@ -52,13 +52,13 @@ \snippet code/doc_src_qtscript.pro 1 For detailed information on how to make your application - scriptable with QtScript, see \l{Making Applications + scriptable with Qt Script, see \l{Making Applications Scriptable}. \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 + use the Qt Script 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 @@ -70,7 +70,7 @@ sufficient for most use cases and is not dependent on LGPL code. \legalese - QtScript is licensed under the GNU Library General Public License. + Qt Script is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code. diff --git a/src/script/doc/src/qtscriptextensions.qdoc b/src/script/doc/src/qtscriptextensions.qdoc index 2a7c27e..294513f 100644 --- a/src/script/doc/src/qtscriptextensions.qdoc +++ b/src/script/doc/src/qtscriptextensions.qdoc @@ -27,10 +27,10 @@ /*! \page qtscriptextensions.html - \title Creating QtScript Extensions - \brief A guide to creating and using QtScript extensions. + \title Creating Qt Script Extensions + \brief A guide to creating and using Qt Script extensions. - QtScript extensions can make additional functionality available to scripts + Qt Script extensions can make additional functionality available to scripts evaluated by a QScriptEngine. Extensions are imported by calling the QScriptEngine::importExtension() function. -- cgit v1.2.1