diff options
author | Leena Miettinen <riitta-leena.miettinen@nokia.com> | 2010-11-19 16:22:14 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@nokia.com> | 2010-11-19 16:22:14 +0100 |
commit | 33ac00afbe859d90f706fdbddd3e144bdc7d9602 (patch) | |
tree | 1f9cb204ca6541cde4be2dde3489b8640287a9f9 | |
parent | 8959874793ee6d5a62b348b2de45b9ca4fce494d (diff) |
Doc: replace Qt SDK product name with a macro
Reviewed-by: Oswald Buddenhagen
-rw-r--r-- | doc/maemodev.qdoc | 18 | ||||
-rw-r--r-- | doc/qtcreator.qdoc | 36 | ||||
-rw-r--r-- | doc/qtcreator.qdocconf | 1 | ||||
-rw-r--r-- | doc/symbiandev.qdoc | 36 |
4 files changed, 50 insertions, 41 deletions
diff --git a/doc/maemodev.qdoc b/doc/maemodev.qdoc index 3dd1681c57b..18cc4af9d96 100644 --- a/doc/maemodev.qdoc +++ b/doc/maemodev.qdoc @@ -45,10 +45,10 @@ Maemo is a software platform developed by Nokia for smartphones and Internet Tablets. The Maemo SDK provides an open development environment for different applications on top of the Maemo platform. The necessary - tools from the Maemo SDK are also included in the Nokia Qt SDK. + tools from the Maemo SDK are also included in the \QSDK. The whole tool chain that you need to create, build, debug, run, and deploy - Maemo applictions is installed and configured when you install the Nokia - Qt SDK. + Maemo applictions is installed and configured when you install the + \QSDK. \if defined(qcmanual) Maemo 5 is based on the Linux 2.6 operating system. For more @@ -70,7 +70,7 @@ \if defined(qcmanual) \o MADDE cross-platform Maemo development - tool (installed as part of the Nokia Qt SDK). + tool (installed as part of the \QSDK). For more information about MADDE pertaining to its installation, configuration, and deployment on the device, see @@ -81,7 +81,7 @@ Only needed if you develop on Windows and if you use a USB connection to run applications on the device. The drivers are - installed as part of the Nokia Qt SDK. You can also download them from + installed as part of the \QSDK. You can also download them from \l{https://garage.maemo.org/frs/?group_id=801&release_id=2655}{PC Connectivity} on the Maemo web site. Download and install the latest PC_Connectivity_<version>.exe (at the time of writing, @@ -232,7 +232,7 @@ \if defined(qcmanual) \section1 Setting Up MADDE - If you install Nokia Qt SDK, the MADDE package is installed and + If you install \QSDK, the MADDE package is installed and configured automatically on your development PC and you can omit this task. \list 1 @@ -275,7 +275,7 @@ devices, you must set up a connection to the emulator and the device in the Qt Creator build and run settings. \if defined(qcmanual) - If you install Nokia Qt SDK, the + If you install \QSDK, the necessary software is installed and configured automatically and you only need to configure a connection to the device. @@ -353,7 +353,7 @@ \endlist - If you installed the Nokia Qt SDK, a connection has been configured + If you installed the \QSDK, a connection has been configured and you only need to specify the password and deploy the SSH key. \o To deploy applications and run them remotely, specify parameters @@ -417,7 +417,7 @@ \else - The Nokia Qt SDK installation program configured a default connection + The \QSDK installation program configured a default connection to the Maemo emulator. You only need to specify the password and deploy the SSH key. diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc index 48fd5d24ba7..138cfb83d20 100644 --- a/doc/qtcreator.qdoc +++ b/doc/qtcreator.qdoc @@ -67,7 +67,7 @@ \list \o \l{Building and Running an Example Application} \o \l{Creating a Qt C++ Application} - \o \l{Creating a Mobile Application with Nokia Qt SDK} + \o \l{Creating a Mobile Application with Qt SDK} \o \l{Creating a Qt Quick Application} \endlist \o \l{Managing Projects} @@ -196,7 +196,7 @@ system that you use. Qt Creator provides support for building and running Qt applications for - desktop environment and mobile devices. When you install the Nokia Qt SDK, + desktop environment and mobile devices. When you install the \QSDK, the build and run settings for the Maemo and Symbian targets are set up automatically. However, you need to install and configure some additional software on the devices. @@ -372,7 +372,7 @@ can change the information that the device has about its configuration and environment. - The Qt Simulator is installed as part of the Nokia Qt SDK. After it is + The Qt Simulator is installed as part of the \QSDK. After it is installed, you can select it as a build target in Qt Creator. \section1 Debuggers @@ -422,7 +422,7 @@ deeper understanding is used to present objects of such classes in a useful way. - If you install Qt Creator as part of a Qt SDK, the GNU Symbolic Debugger + If you install Qt Creator as part of a \QSDK, the GNU Symbolic Debugger is installed automatically and you should be ready to start debugging after you create a new project. However, you can change the setup to use debugging tools for Windows, for example. @@ -797,7 +797,7 @@ \section1 Finding Information in Qt Documentation - Qt Creator, Qt SDK, Nokia Qt SDK and other Qt deliverables contain documentation + Qt Creator, \QSDK and other Qt deliverables contain documentation as .qch files. All the documentation is accessible in the \gui Help mode. To find information in the documentation, select: @@ -2635,7 +2635,7 @@ \section3 Troubleshooting MinGW Compilation Errors If error messages displayed in the \gui {Compile Output} pane contain - paths where slashes are missing (for example, C:NokiaQtSDK), + paths where slashes are missing (for example, C:QtSDK), check your PATH variable. At the command line, enter the following commands: \code @@ -2874,7 +2874,7 @@ \title Building and Running Applications Qt Creator provides support for building and running Qt applications for - desktop environment and mobile devices. When you install the Nokia Qt SDK, + desktop environment and mobile devices. When you install the \QSDK, the build and run settings for the Maemo and Symbian targets are set up automatically. @@ -3112,11 +3112,11 @@ devices, such as S60 3rd Edition or S60 5th Edition devices. \note Remote Compiler is an experimental component that you must install - separately from the package that is included in the Nokia Qt SDK. + separately from the package that is included in the \QSDK. \list 1 - \o In the Nokia Qt SDK installation directory, double-click + \o In the \QSDK installation directory, double-click SDKMaintenanceTool.exe to install \gui {Experimental APIs}. \o In Qt Creator, choose \gui {Tools > Options > Projects > Remote Compiler} @@ -3596,7 +3596,7 @@ \list \o \l{Building and Running an Example Application} \o \l{Creating a Qt C++ Application} - \o \l{Creating a Mobile Application with Nokia Qt SDK} + \o \l{Creating a Mobile Application with Qt SDK} \o \l{Creating a Qt Quick Application} \endlist @@ -3609,9 +3609,9 @@ \page creator-mobile-example.html \nextpage creator-qml-application.html - \title Creating a Mobile Application with Nokia Qt SDK + \title Creating a Mobile Application with Qt SDK - \note To complete this tutorial, you must install Nokia Qt SDK. + \note To complete this tutorial, you must install \QSDK. The installation program installs and configures the necessary tool chains for mobile application development. @@ -3650,7 +3650,7 @@ and click \gui{Next}. \note Targets are listed if you installed the appropriate development - environment, for example, as part of the Nokia Qt SDK. You can add targets + environment, for example, as part of the \QSDK. You can add targets later in the \gui Projects mode. The \gui {Application Options} dialog opens. @@ -5408,7 +5408,7 @@ \note Visual Studio does not include the Debugging tools needed, and therefore, you must install them separately. - The pre-built \e{Qt SDK for Windows} makes use + The pre-built \QSDK for Windows makes use of the library if it is present on the system. When manually building Qt Creator using the Microsoft Visual C++ Compiler, the build process checks for the required files in \c{"%ProgramFiles%\Debugging Tools for Windows"}. @@ -5854,7 +5854,7 @@ During debugging with the C++ based debugging helpers, Qt Creator dynamically loads a helper library in form of a DLL or a shared object into the debugged process. - The Qt SDK package already contains a prebuilt debugging helper + The \QSDK package already contains a prebuilt debugging helper library. To create your own debugging helper library, select \gui{Tools} > \gui{Options...} > \gui{Qt4} > \gui{Qt Versions}. As the internal data structures of Qt can change between versions, the debugging helper @@ -7269,7 +7269,7 @@ instead. For more information, see the \l{http://doc.qt.nokia.com/qt-simulator-beta/index.html}{Qt Simulator Manual}. - The Maemo emulator is installed and configured as part of the Nokia Qt SDK + The Maemo emulator is installed and configured as part of the \QSDK package. You can also install and configure the MADDE environment and Maemo emulator separately. For more information, see \l{Setting Up Development Environment for Maemo}. @@ -8413,10 +8413,10 @@ \o Building and packaging subprojects is not supported for Maemo devices. \o You must create projects for Maemo targets on the same partition where - you installed Nokia Qt SDK, Qt Creator, and MADDE. + you installed \QSDK, Qt Creator, and MADDE. \o If error messages displayed in the \gui {Compile Output} pane contain - paths where slashes are missing (for example, C:NokiaQtSDK), + paths where slashes are missing (for example, C:QtSDK), check your PATH variable. For more information, see \l{Troubleshooting MinGW Compilation Errors}. diff --git a/doc/qtcreator.qdocconf b/doc/qtcreator.qdocconf index e7079b74f7e..0a3e8d64fb8 100644 --- a/doc/qtcreator.qdocconf +++ b/doc/qtcreator.qdocconf @@ -87,6 +87,7 @@ macro.QL = "\\e{Qt Linguist}" macro.QC = "\\e{Qt Creator}" macro.QMLD = "\\e{Qt Quick Designer}" macro.QQV = "\\e{Qt QML Viewer}" +macro.QSDK = "\\e{Qt SDK}" macro.param = "\\e" macro.raisedaster.HTML = "<sup>*</sup>" macro.reg.HTML = "<sup>®</sup>" diff --git a/doc/symbiandev.qdoc b/doc/symbiandev.qdoc index 50a91804561..0ee22fc4c2c 100644 --- a/doc/symbiandev.qdoc +++ b/doc/symbiandev.qdoc @@ -30,7 +30,7 @@ \if defined(qcmanual) \previouspage creator-developing-maemo.html \else - \previouspage nokiaqtsdk-gs.html + \previouspage sdk-gs.html \endif \page creator-developing-symbian.html \if defined(qcmanual) @@ -63,9 +63,10 @@ \endif application for your device \o The \e{qt_installer.sis} package installed on the device, that is - delivered with the Qt SDK + delivered with the \QSDK \o \e {Qt Mobility APIs} installed on the device, if you use them in applications + \o \QQV to run Qt Quick applications on Symbian^3 devices. \endlist \if defined(qcmanual) @@ -75,7 +76,7 @@ \section1 Installing Required Applications on Devices - The Nokia Qt SDK installation program creates shortcuts for installing + The \QSDK installation program creates shortcuts for installing the required applications on Symbian devices (you can also use any of the standard methods for installing applications on devices): @@ -86,17 +87,24 @@ or PC Suite, all the necessary drivers are installed automatically. This takes approximately one minute. - \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install Qt to Symbian - device} and follow the instructions on the screen to install Qt 4.6.2 - libraries on the device. + \o Choose \gui {Start > Qt SDK > Symbian > Install Qt 4.7.1 to Symbian^1 + Device} or \gui {Install Qt 4.7.1 to Symbian^3 Device}, depending on the + device type. Follow the instructions on the screen to install Qt + libraries to the device. - \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install QtMobility to Symbian - device} and follow the instructions on the screen to install Qt - mobility libraries on the device. + \o Choose \gui {Start > Qt SDK > Symbian > Install QtMobility 1.1.0 to + Symbian^1 Device} or \gui {Install QtMobility 1.1.0 to Symbian^3 Device} + and follow the instructions on the screen to install Qt + mobility libraries to the device. - \o Choose \gui {Start > Nokia Qt SDK > Symbian > Install TRK to Symbian - device} and follow the instructions on the screen to install the TRK - debugging application on the device. + \o Choose \gui {Start > Qt SDK > Symbian > Install TRK (Debug Agent) + to Symbian^1 Device} or \gui {Install TRK (Debug Agent) to Symbian^3 + Device} and follow the instructions on the screen to install the TRK + debugging application to the device. + + \o Choose \gui {Start > Qt SDK > Symbian > Install QML Viewer + to Symbian^3 Device} and follow the instructions on the screen to + install \QQV to the device. \note To check the Symbian platform version of your device, see \l{http://www.forum.nokia.com/devices}{Device Details}. @@ -104,13 +112,13 @@ \endlist \note If errors occur during the installation, copy the .sis files from - \c {<NokiaQtSDK_install_path>\Symbian\sis} to the device using USB storage + \c {<QtSDK_install_path>\Symbian\sis} to the device using USB storage mode. Then install them from the file manager on the device. \if defined(qcmanual) \section1 Adding Symbian Platform SDKs - Nokia Qt SDK contains all the tools you need for developing Qt applications for + \QSDK contains all the tools you need for developing Qt applications for Symbian devices. To use Symbian APIs directly in your applications, you can install additional Symbian Platform SDKs: |