From 22a162a79716c0625524941a9d38d429e9ac9109 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@nokia.com>
Date: Thu, 23 Sep 2010 17:28:21 +0200
Subject: [PATCH] Doc - Change the structure to improve navigation
---
doc/qtcreator.qdoc | 151 +++++++++++++++++++++------------------------
1 file changed, 69 insertions(+), 82 deletions(-)
diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc
index 18d754b55ff..c17c0347e41 100644
--- a/doc/qtcreator.qdoc
+++ b/doc/qtcreator.qdoc
@@ -154,12 +154,64 @@
\image qtcreator-overview.png "Qt Creator overview"
- \section1 Projects
+ \section1 Cross-platform Development
One of the major advantages of Qt Creator is that it allows a team of developers
to share a project across different development platforms with a common tool
for development and debugging.
+ The recommended way to build a project is to use a version control system.
+ Store and edit only project source files and the .pro and .pri files (for qmake)
+ or CMakeLists.txt and *.cmake files (for CMake). Do not store
+ files generated by the build system or Qt Creator, such as makefiles,
+ .pro.user, and object files. Other approaches are possible,
+ but we recommend that you do not use network resources, for example.
+
+ Qt Creator allows you to specify separate build settings
+ for each development platform. By default, \l{glossary-shadow-build}{shadow builds} are used to
+ keep the build specific files separate from the source.
+
+ You can create separate versions of project files to keep platform-dependent
+ code separate. You can use qmake
+ \l{http://qt.nokia.com/doc/4.7/qmake-tutorial.html#adding-platform-specific-source-files}{scopes}
+ to select the file to process depending on which platform qmake is run on.
+
+ Items such as open files, breakpoints, and watches are stored in
+ sessions. They are not considered to be part of the
+ information shared across platforms.
+
+ Qt Creator is integrated with cross-platform systems for build automation:
+ qmake and CMake. In addition, you can import generic projects that do not use qmake
+ or CMake, and specify that Qt Creator ignores your build system.
+
+ In addition to Qt libraries, you can link your application to other
+ libraries, such as system libraries or your own libraries. Further, your
+ own libraries might link to other libraries. To be able to compile your
+ project, you must add the libraries to your project. This also enables
+ code completion and syntax highlighting for the libraries.
+ The procedure of adding a library to a project depends on the the build
+ 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,
+ 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.
+
+ \note The only supported build system for mobile applications in Qt
+ Creator is qmake.
+
+ Once your mobile application is ready, you can test it in the Qt Simulator.
+ You can also connect Maemo and Symbian devices to your development PC and
+ debug applications on the devices. After you have tested the application,
+ you can deploy it on mobile devices.
+
+ Developing applications for mobile devices is different from developing
+ desktop applications. For more information, see
+ \l{Optimizing Applications for Mobile Devices}.
+
+ \section1 Projects
+
But why do you need projects? To be able to build and run applications,
Qt Creator needs the same information as a compiler would need. This information
is specified in the project build and run settings.
@@ -190,7 +242,8 @@
\section1 Editors
- Qt Creator comes with a code editor and an integrated \QD for designing and building
+ Qt Creator comes with a code editor and two integrated visual editors for designing
+ and building
graphical user interfaces (GUIs) from Qt widgets.
\section2 Code Editor
@@ -286,7 +339,6 @@
\section2 Version Control Systems
- The recommended way to build a project is to use a version control system.
Qt Creator uses the version control system's command line clients to access
your repositories. The following version control systems are supported:
@@ -1697,89 +1749,20 @@
developers to share a project across different development platforms with a common
tool for development and debugging.
- The recommended way to build a project is to use a \l{Using Version Control Systems} {version control system}.
- Store and edit only project source files and the .pro and .pri files (for qmake)
- or CMakeLists.txt and *.cmake files (for CMake). Do not store
- files generated by the build system or Qt Creator, such as makefiles,
- .pro.user, and object files. Other approaches are possible,
- but we recommend that you do not use network resources, for example.
+ The following sections describe how to manage projects:
- Qt Creator allows you to specify separate \l{Building for and Running on Multiple Targets} {build settings}
- for each development platform. By default, \l{glossary-shadow-build}{shadow builds} are used to
- keep the build specific files separate from the source.
-
- You can create separate versions of project files to keep platform-dependent
- code separate. You can use qmake
- \l{http://qt.nokia.com/doc/4.2/qmake-tutorial.html#adding-platform-specific-source-files}{scopes}
- to select the file to process depending on which platform qmake is run on.
-
- Items such as open files, breakpoints, and watches are stored in
- \l{Managing Sessions}{sessions}. They are not considered to be part of the
- information shared across platforms.
-
- Qt Creator is integrated with cross-platform systems for build automation:
- qmake and CMake. In addition, you can import generic projects that do not use qmake
- or CMake, and specify that Qt Creator ignores your build system.
\list
- \o To use \bold{qmake} to build applications, open a \c .pro file. For more
- information, see \l{Setting Up a qmake Project}.
- \o To use \bold{CMake} to build applications you need to have CMake version
- 2.8.0 or later installed. For more information, see
- \l{Setting Up a CMake Project}.
- \o To use \bold{other build systems} to build applications, specify which files belong to
- your project and which include directories or defines you want to pass
- to your compiler. For more information, see
- \l{Setting Up a Generic Project}.
- \endlist
-
- Qt Creator provides support for \l{Building and Running Applications}{building and running} Qt applications for
- desktop environment and mobile devices. When you install the Nokia Qt SDK,
- 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:
-
- \list
-
- \o \l{Setting Up Development Environment for Maemo}.
-
- \o \l{Setting Up Development Environment for Symbian}.
-
+ \o \l{Creating a Project}
+ \o \l{Setting Up a qmake Project}
+ \o \l{Adding Libraries to qmake Projects}
+ \o \l{Setting Up a CMake Project}
+ \o \l{Setting Up a Generic Project}
+ \o \l{Setting Up Development Environment for Maemo}
+ \o \l{Setting Up Development Environment for Symbian}
+ \o \l{Managing Sessions}
+ \o \l{Adding New Custom Wizards}
\endlist
- \note The only supported build system for mobile applications in Qt
- Creator is qmake.
-
- Once your mobile application is ready, you can test it in the Qt Simulator.
- You can also connect Maemo and Symbian devices to your development PC and
- debug applications on the devices. After you have tested the application,
- you can deploy it on mobile devices.
-
- Developing applications for mobile devices is different from developing
- desktop applications. For more information, see
- \l{Optimizing Applications for Mobile Devices}.
-
- To change the location of the project directory, and to make changes in
- the build and run settings, select \gui{Tools} > \gui{Options...} >
- \gui{Projects} > \gui{General}.
-
- \section1 Adding Libraries
-
- In addition to Qt libraries, you can link your application to other
- libraries, such as system libraries or your own libraries. Further, your
- own libraries might link to other libraries. To be able to compile your
- project, you must add the libraries to your project. This also enables
- code completion and syntax highlighting for the libraries
-
- The procedure of adding a library to a project depends on the the build
- system that you use:
-
- \list
- \o For information on adding libraries to qmake projects, see
- \l{Adding Libraries to qmake Projects}.
- \o For information on adding libraries to CMake projects, see
- \l{Adding External Libraries to CMake Projects}.
- \endlist
-
*/
@@ -1816,6 +1799,10 @@
\image qtcreator-new-project.png
+ To change the location of the project directory, and to make changes in
+ the build and run settings, select \gui{Tools} > \gui{Options...} >
+ \gui{Projects} > \gui{General}.
+
\section1 Using Project Wizards
To create a new project:
--
GitLab