diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-01-22 18:00:26 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-01-24 11:26:54 +0100 |
commit | 8759cf3fcb3b78a7b62e7f4feedee8e6822bde32 (patch) | |
tree | a5e26f9a3c0d6cd8673204a587f3bbf1f5696569 /src/scripttools/doc/src/qtscripttools-module.qdoc | |
parent | 848ddbe91b5219214f43892d325d7e5e9ddc0489 (diff) |
Doc: Modularized Qt Script Tools documentation.
-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 <jedrzej.nowacki@digia.com>
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
Diffstat (limited to 'src/scripttools/doc/src/qtscripttools-module.qdoc')
-rw-r--r-- | src/scripttools/doc/src/qtscripttools-module.qdoc | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/src/scripttools/doc/src/qtscripttools-module.qdoc b/src/scripttools/doc/src/qtscripttools-module.qdoc new file mode 100644 index 0000000..bc89994 --- /dev/null +++ b/src/scripttools/doc/src/qtscripttools-module.qdoc @@ -0,0 +1,49 @@ +/**************************************************************************** +** +** 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. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module QtScriptTools + \title Qt Script Tools C++ Classes + \since 4.5 + \ingroup modules + + \brief Provides additional components for applications that use Qt Script. + + The \l{Qt Script Tools} module provides a debugger for applications that + use Qt Script. + + \section1 Configuring the Build Process + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc_src_qtscripttools.cpp 0 + + To link against the module, add this line to your \l qmake \c .pro file: + + \snippet doc_src_qtscripttools.pro 1 +*/ |