From 0445e84888cd0d2f9a8c90f3a88317ab05c690d7 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Fri, 16 Jan 2015 11:54:36 +0100 Subject: Doc: Moved the example documentation to correct locations MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Topi Reiniö --- src/script/api/qscriptclass.cpp | 2 +- src/script/doc/qtscript.qdocconf | 2 +- .../snippets/code/doc_src_examples_hellotr.qdoc | 71 ++++++++++++++++++++++ src/script/doc/src/qtscript-index.qdoc | 2 +- src/script/doc/src/qtscript-module.qdoc | 2 +- 5 files changed, 75 insertions(+), 4 deletions(-) create mode 100644 src/script/doc/snippets/code/doc_src_examples_hellotr.qdoc (limited to 'src/script') 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] + + + QPushButton + + Hello world! + + + + +//! [1] + + +//! [2] +linguist hellotr_la.ts +//! [2] + + +//! [3] + +//! [3] + + +//! [4] +Orbis, te saluto! +//! [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 -- cgit v1.2.1