summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2015-01-16 11:54:36 +0100
committerNico Vertriest <nico.vertriest@digia.com>2015-01-19 15:07:16 +0100
commit0445e84888cd0d2f9a8c90f3a88317ab05c690d7 (patch)
tree62af79114ff19f641b605994a3be56467bbc924d /src
parentb459510d57fe78c09adbe3148655e0e3de7776c9 (diff)
downloadqtscript-0445e84888cd0d2f9a8c90f3a88317ab05c690d7.tar.gz
Doc: Moved the example documentation to correct locations
And fix the \snippet commands to use the correct paths. Also edited dependencies qdocconf files Task-number: QTBUG-43810 Change-Id: I3c2fb6d2a48900a9b5651225381707c9ec25065a Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/script/api/qscriptclass.cpp2
-rw-r--r--src/script/doc/qtscript.qdocconf2
-rw-r--r--src/script/doc/snippets/code/doc_src_examples_hellotr.qdoc71
-rw-r--r--src/script/doc/src/qtscript-index.qdoc2
-rw-r--r--src/script/doc/src/qtscript-module.qdoc2
-rw-r--r--src/scripttools/doc/qtscripttools.qdocconf11
-rw-r--r--src/scripttools/doc/src/qtscripttools-index.qdoc2
-rw-r--r--src/scripttools/doc/src/qtscripttools-module.qdoc2
8 files changed, 79 insertions, 15 deletions
diff --git a/src/script/api/qscriptclass.cpp b/src/script/api/qscriptclass.cpp
index de08e4f..b6c654f 100644
--- a/src/script/api/qscriptclass.cpp
+++ b/src/script/api/qscriptclass.cpp
@@ -84,7 +84,7 @@
script class supports one or more of the extensions specified by the
Extension enum.
- \sa QScriptClassPropertyIterator, QScriptEngine::newObject(), {Custom Script Class Example}
+ \sa QScriptClassPropertyIterator, QScriptEngine::newObject(), {Defining Custom Script Classes with QScriptClass}
*/
/*!
diff --git a/src/script/doc/qtscript.qdocconf b/src/script/doc/qtscript.qdocconf
index a58e1e7..f657bd5 100644
--- a/src/script/doc/qtscript.qdocconf
+++ b/src/script/doc/qtscript.qdocconf
@@ -16,7 +16,7 @@ headerdirs += ..
imagedirs += images
sourcedirs += ..
-depends += qtcore qtlinguist qtscripttools qtdoc
+depends += qtcore qtlinguist qtscripttools qtdoc qtqml qtwidgets qmake
# 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/snippets/code/doc_src_examples_hellotr.qdoc b/src/script/doc/snippets/code/doc_src_examples_hellotr.qdoc
new file mode 100644
index 0000000..54464b6
--- /dev/null
+++ b/src/script/doc/snippets/code/doc_src_examples_hellotr.qdoc
@@ -0,0 +1,71 @@
+/****************************************************************************
+**
+** 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:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+** * Redistributions of source code must retain the above copyright
+** notice, this list of conditions and the following disclaimer.
+** * Redistributions in binary form must reproduce the above copyright
+** notice, this list of conditions and the following disclaimer in
+** the documentation and/or other materials provided with the
+** distribution.
+** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
+** of its contributors may be used to endorse or promote products derived
+** from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//! [0]
+lupdate -verbose hellotr.pro
+//! [0]
+
+
+//! [1]
+<!DOCTYPE TS><TS>
+<context>
+ <name>QPushButton</name>
+ <message>
+ <source>Hello world!</source>
+ <translation type="unfinished"></translation>
+ </message>
+</context>
+</TS>
+//! [1]
+
+
+//! [2]
+linguist hellotr_la.ts
+//! [2]
+
+
+//! [3]
+<translation type='unfinished'></translation>
+//! [3]
+
+
+//! [4]
+<translation>Orbis, te saluto!</translation>
+//! [4]
diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc
index 663b1e6..242083a 100644
--- a/src/script/doc/src/qtscript-index.qdoc
+++ b/src/script/doc/src/qtscript-index.qdoc
@@ -1315,7 +1315,7 @@
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}.
+ Qt Script examples, located in \c{examples/script}.
\section2 Prototype Objects and Shared Properties
diff --git a/src/script/doc/src/qtscript-module.qdoc b/src/script/doc/src/qtscript-module.qdoc
index f355431..35a2830 100644
--- a/src/script/doc/src/qtscript-module.qdoc
+++ b/src/script/doc/src/qtscript-module.qdoc
@@ -48,7 +48,7 @@
\snippet code/doc_src_qtscript.cpp 0
- To link against the module, add this line to your \l qmake \c .pro file:
+ To link against the module, add this line to your \l {qmake Manual}{qmake} \c .pro file:
\snippet code/doc_src_qtscript.pro 1
diff --git a/src/scripttools/doc/qtscripttools.qdocconf b/src/scripttools/doc/qtscripttools.qdocconf
index 95ebf8a..4eae186 100644
--- a/src/scripttools/doc/qtscripttools.qdocconf
+++ b/src/scripttools/doc/qtscripttools.qdocconf
@@ -3,20 +3,13 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
# Name of the project which must match the outputdir. Determines the .index file
project = QtScriptTools
-# Directories in which to search for files to document and images.
-# By default set to the root directory of the project for sources
-# and headers and qdoc will therefore generate output for each file.
-# Images should be placed in <rootdir>/dic/images and examples in
-# <rootdir>/examples.
-# Paths are relative to the location of this file.
-exampledirs += ../../../examples \
- snippets
+exampledirs += snippets
headerdirs += ..
imagedirs += images
sourcedirs += ..
-depends += qtcore qtlinguist qtscript qtdoc
+depends += qtcore qtlinguist qtscript qtdoc qtwidgets qtqml qmake
# 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/scripttools/doc/src/qtscripttools-index.qdoc b/src/scripttools/doc/src/qtscripttools-index.qdoc
index 1817753..435ad6b 100644
--- a/src/scripttools/doc/src/qtscripttools-index.qdoc
+++ b/src/scripttools/doc/src/qtscripttools-index.qdoc
@@ -42,7 +42,7 @@
\snippet doc_src_qtscripttools.cpp 0
- To link against the module, add this line to your \l qmake \c .pro file:
+ To link against the module, add this line to your \l {qmake Manual}{qmake} \c .pro file:
\snippet doc_src_qtscripttools.pro 1
diff --git a/src/scripttools/doc/src/qtscripttools-module.qdoc b/src/scripttools/doc/src/qtscripttools-module.qdoc
index fea9a99..f5e3b17 100644
--- a/src/scripttools/doc/src/qtscripttools-module.qdoc
+++ b/src/scripttools/doc/src/qtscripttools-module.qdoc
@@ -44,7 +44,7 @@
\snippet doc_src_qtscripttools.cpp 0
- To link against the module, add this line to your \l qmake \c .pro file:
+ To link against the module, add this line to your \l {qmake Manual}{qmake} \c .pro file:
\snippet doc_src_qtscripttools.pro 1
*/