diff options
author | Marianne Yrjänä <marianne.yrjana@qt.io> | 2018-05-21 14:28:07 +0300 |
---|---|---|
committer | Marianne Yrjänä <marianne.yrjana@qt.io> | 2018-05-22 06:17:44 +0000 |
commit | 72d61ffdf581547f0f3e0f6a29201fadabfec0ab (patch) | |
tree | 0e83314f56cea2f5965f6a6263e0e3fff81c218b /doc | |
parent | 1496a0e10e87922f8f7d1a9735a5264bf63061a9 (diff) |
Remove examples documentation
All but presentation-only examples are now located under runtime2 so
remove also corresponding documentation from studio.
Task-number: QT3DS-1724
Change-Id: I20e80bd62d9b00bfb569b34d5f5dc7082ff9965b
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/00-concepts.qdoc | 1 | ||||
-rw-r--r-- | doc/src/examples-index.qdoc | 93 | ||||
-rw-r--r-- | doc/style/qt5-sidebar.html | 1 |
3 files changed, 0 insertions, 95 deletions
diff --git a/doc/src/00-concepts.qdoc b/doc/src/00-concepts.qdoc index aab79d91..bf8973ff 100644 --- a/doc/src/00-concepts.qdoc +++ b/doc/src/00-concepts.qdoc @@ -45,7 +45,6 @@ \li \l {Best Practices} \li \l {Requirements} \li \l {Experimental Features} - \li \l {Examples} \li \l {Copyright Notices} \endlist diff --git a/doc/src/examples-index.qdoc b/doc/src/examples-index.qdoc deleted file mode 100644 index 3ce54d54..00000000 --- a/doc/src/examples-index.qdoc +++ /dev/null @@ -1,93 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of Qt 3D Studio. -** -** $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 The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! -\title Examples -\ingroup qml-examples -\page qtstudio3d-qml-examples.html -\noautolist - -Included in Qt 3D Studio you will find a set of examples. These are located in the \c {examples} -folder in the installation folder. - -\section1 Instructions - -To compile the examples or other Qml or C++ applications you also need to install Qt in addition -to Qt 3D Studio. Binaries provided by Qt 3D Studio installer are compiled with Qt 5.10.1 -and MSVC2015_64bit (win), clang_64 (macOS) and gcc 64bit (linux). For other combinations you need -to compile Qt 3D Studio yourself from sources. In that case, refer to the \e{build_instructions} -document available in the source code repository. - -Extra setup steps after installing Qt 3D Studio and Qt 5.10.1: - -\list 1 - \li Copy \c{<Qt 3D Studio installation directory>\Tools\Qt3DStudio\qml\QtStudio3D} under - \c{<Qt installation directory>\5.10.1\<compiler>\qml} (e.g. \c{C:\Qt\5.10.1\msvc2015_64\qml}). - \li Open the application's \c{.pro} file in Qt Creator. - \li Add \c{<Qt 3D Studio installation directory>\Tools\Qt3DStudio\bin} to the end of the PATH - variable in the \e{Run Environment} for the build. - See \l{http://doc.qt.io/qtcreator/creator-build-settings.html#using-environment-variables} - for details on how to set environment variables. -\endlist - -Additional two steps are needed if you are running macOS: - -\list 1 - \li Add \c{<Qt 3D Studio installation directory>\Tools\Qt3DStudio\lib} to the end of the - DYLD_FRAMEWORK_PATH variable in the Run Environment for the build. - \li Add \c{<Qt 3D Studio installation directory>\Tools\Qt3DStudio\lib} to the end of the - DYLD_LIBRARY_PATH variable in the Run Environment for the build. -\endlist - -Additional three steps are needed for C++ applications: -\list 1 - \li Copy \c{<Qt 3D Studio installation directory>\Tools\Qt3DStudio\include\QtStudio3D} under - \c{<Qt installation directory>\5.10.1\<compiler>\include} - (e.g. \c{C:\Qt\5.10.1\msvc2015_64\include}). - \li Copy \c{qt_lib_studio3d.pri} and \c{qt_lib_studio3d_private.pri} from - \c{<Qt 3D Studio installation directory>\Tools\Qt3DStudio\mkspecs\modules} to - \c{<Qt installation directory>\5.10.1\<compiler>\mkspecs\modules} - (e.g. \c{C:\Qt\5.10.1\msvc2015_64\mkspecs\modules}). - \li Open the application's \c{.pro} file in Qt Creator and add - \c{LIBS += -L<Qt 3D Studio installation directory>/Tools/Qt3DStudio/lib Qt5Studio3D$$qtPlatformTargetSuffix()} - to your application’s \c{.pro} file. -\endlist - -\section1 QML Examples - -\list - \li \l {Qt 3D Studio: Dynamic Keyframes Example} - \li \l {Qt 3D Studio: QML Streamer Example} - \li \l {Qt 3D Studio: QML DataInput Example} -\endlist - -\section1 More Examples - -You can find more examples from \l {https://git.qt.io/public-demos/qt3dstudio} -, these examples are more visually appealing and suitable to use as for example demos. - -*/ diff --git a/doc/style/qt5-sidebar.html b/doc/style/qt5-sidebar.html index c0e3c87e..eb007c75 100644 --- a/doc/style/qt5-sidebar.html +++ b/doc/style/qt5-sidebar.html @@ -15,7 +15,6 @@ <li><a href="qt3dstudio-best-practices.html">Best Practices</a></li> <li><a href="requirements.html">Requirements</a></li> <li><a href="experimental-features.html">Experimental Features</a></li> - <li><a href="qtstudio3d-qml-examples.html">Examples</a></li> <li><a href="copyright-notices.html">Copyright Notices</a></li> </ul> </div> |