diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-02-15 17:00:09 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-02-19 15:28:14 +0000 |
commit | 76539a659e9cc10a6019b3f5d3a5851b761e58f5 (patch) | |
tree | 7bf3bd9f167e646ffaa8ddc61fe2fdc8cba354a0 /doc/qtcreator | |
parent | 8a6d94235bb90f8fdea760ce7e75023270658d59 (diff) |
Doc: Update the IDE Overview
Use sections instead of a table and move or copy text from
other topics. This is to create a place for information that
becomes homeless when I remove other topics.
Task-number: QTCREATORBUG-29361
Change-Id: Ib3fcc2c345080e05f9f7ad4ed78e049c899e0855
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Diffstat (limited to 'doc/qtcreator')
-rw-r--r-- | doc/qtcreator/images/heartgame-start.webp | bin | 0 -> 25644 bytes | |||
-rw-r--r-- | doc/qtcreator/images/qt-app-dev-flow.webp | bin | 0 -> 123844 bytes | |||
-rw-r--r-- | doc/qtcreator/images/qt-tools.webp | bin | 0 -> 53570 bytes | |||
-rw-r--r-- | doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc | 12 | ||||
-rw-r--r-- | doc/qtcreator/src/editors/creator-code-refactoring.qdoc | 14 | ||||
-rw-r--r-- | doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc | 4 | ||||
-rw-r--r-- | doc/qtcreator/src/overview/creator-only/creator-overview.qdoc | 378 | ||||
-rw-r--r-- | doc/qtcreator/src/overview/creator-only/creator-testing.qdoc | 2 | ||||
-rw-r--r-- | doc/qtcreator/src/qtcreator-toc.qdoc | 2 | ||||
-rw-r--r-- | doc/qtcreator/src/qtcreator.qdoc | 2 |
10 files changed, 242 insertions, 172 deletions
diff --git a/doc/qtcreator/images/heartgame-start.webp b/doc/qtcreator/images/heartgame-start.webp Binary files differnew file mode 100644 index 0000000000..9fef6fe005 --- /dev/null +++ b/doc/qtcreator/images/heartgame-start.webp diff --git a/doc/qtcreator/images/qt-app-dev-flow.webp b/doc/qtcreator/images/qt-app-dev-flow.webp Binary files differnew file mode 100644 index 0000000000..14be8fb3d7 --- /dev/null +++ b/doc/qtcreator/images/qt-app-dev-flow.webp diff --git a/doc/qtcreator/images/qt-tools.webp b/doc/qtcreator/images/qt-tools.webp Binary files differnew file mode 100644 index 0000000000..986846140f --- /dev/null +++ b/doc/qtcreator/images/qt-tools.webp diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc index 0676655ec5..914ee67465 100644 --- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc +++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc @@ -14,18 +14,6 @@ \title Debugging - A debugger lets you see what happens \e inside an application while it runs - or when it crashes. A debugger can do the following to help you find errors - in the application: - - \list - \li Start the application with parameters that specify its behavior. - \li Stop the application when conditions are met. - \li Examine what happens when the application stops. - \li Make changes in the application when you fix an error and continue - to find the next one. - \endlist - The \QC debugger plugin acts as an interface between the \QC core and external native debuggers that you can use to: diff --git a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc index 285c36166b..413ffe9ef5 100644 --- a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc +++ b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc @@ -8,20 +8,6 @@ \title Refactoring - \e {Code refactoring} is the process of improving and simplifying code - without modifying the existing functionality of an application. You - can easily find and rename symbols and apply predefined actions to - refactor code. - - Refactor code to: - - \list - \li Improve internal quality of your application - \li Improve performance and extensibility - \li Improve code readability and maintainability - \li Simplify code structure - \endlist - To quickly and conveniently apply actions to refactor your code, \l{Apply quick fixes}{select quick fixes in a context menu}. diff --git a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc index 68ca9e4ef5..115e666d0b 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc @@ -25,11 +25,11 @@ \li \inlineimage front-ui.png \li \inlineimage front-advanced.png \row - \li \b {\l{IDE Overview}} + \li \b {\l{Overview}} If you have not used an integrated development environment (IDE) before, or want to know what kind of IDE \QC is, go to - \l{IDE Overview}. + \l{Overview}. \li \b {\l{User Interface}} If you have not used \QC before, and want to become familiar diff --git a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc index f951b4b52a..eb0bcf8ec3 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2023 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // ********************************************************************** @@ -12,147 +12,243 @@ \page creator-overview.html \nextpage creator-quick-tour.html - \title IDE Overview + \title Overview - \QC is an integrated development environment (IDE) that has tools for - designing and developing applications with the Qt application framework. - With Qt you can develop applications and user interfaces once and deploy - them to several desktop, embedded, and mobile operating systems or - web browsers (experimental). \QC has the tools for accomplishing your tasks + \QC is a cross-platform, complete integrated development environment + (IDE) that you can use to create applications for desktop, embedded, + and mobile operating systems, or web browsers. + + With Qt, you can develop applications and user interfaces once and deploy + them to many platforms. \QC has the tools for accomplishing your tasks throughout the whole application development life-cycle, from creating a - project to deploying the application to the target platforms. - - \table - \row - \li \inlineimage front-projects.png - \li \inlineimage front-ui.png - \li \inlineimage front-coding.png - \row - \li \b {Managing Projects} - - To be able to build and run applications, \QC needs the same - information as a compiler would need. It stores the information - in the project settings. - - You can share projects with other designers and developers across - different development platforms with a common tool for design, - development, and debugging. - - \list - \li \l{Creating Projects} - - To set up a project, you first have to decide what kind - of an application you want to develop: do you want a user - interface based on \l{User Interfaces} - {Qt Quick or Qt Widgets}. Second, you have to choose the - programming language to implement the application logic: - C++ or Python. - \li \l{Version Control Systems} - - The recommended way to set up a project is to use a - version control system. Store and edit only project - source files and configuration files. Do not store - generated files. - \li \l{Configuring Projects} - - Installation programs and project wizards create default - configurations for \QC and your projects. You can change - the configurations in the \uicontrol Projects mode. - \endlist - For more information, see \l{Manage Projects} - {How To: Manage Projects}. - \li \b {Designing User Interfaces} - - To create intuitive, modern-looking, fluid user interfaces, you - can use \l{Qt Quick} and \l{Qt Design Studio Manual}{\QDS}: - - \list - \li \l {\QMLD} - - Or, you can enable the \QMLD plugin to visually edit - \l{UI Files}{UI files} (.ui.qml). - \li \l {Converting UI Projects to Applications} - - Qt Quick UI Prototype projects (.qmlproject) are useful - for creating user interfaces. To use them for application - development, you have to convert them to Qt Quick - Application projects that have project configuration - files (CMakeLists.txt or .pro), .cpp, and .qrc files. - \li \l {UI Files} - - If you switch between \QC and \QDS or cooperate with - designers on a project, you might encounter .ui.qml files. - They are intended to be edited in \QDS only, so you need - to be careful not to break the code. To visually edit the - files in \QC, enable the \QMLD plugin. - \li \l{Using QML Modules with Plugins} - - You can load C++ plugins for QML to simulate data. - \endlist - - If you need a traditional user interface that has a clear - structure and enforces a platform look and feel, use - \l{Qt Widgets} and the integrated \l{\QD}. - - For more information, see - \l{Design UIs}{How To: Design UIs}. - \li \b {\l{Coding}} - - As an IDE, \QC differs from a text editor in that it knows how - to build and run applications. It understands the C++ and QML - languages as code, not just as plain text. Therefore, it can - offer useful features, such as semantic highlighting, - checking code syntax, code completion, and refactoring actions. - \QC supports some of these services also for other programming - languages, such as Python, for which a \e {language server} is - available that provides information about the code to IDEs. - - For more information, see \l{Edit Code}{How To: Edit Code}. - \row - \li \inlineimage front-preview.png - \li \inlineimage front-testing.png - \li \inlineimage front-publishing.png - \row - \li \b {\l{Building and Running}} - - \QC integrates cross-platform systems for build - automation: qmake, Qbs, CMake, and Autotools. In addition, you - can import - projects as \e {generic projects} and fully control the steps - and commands used to build the project. - - You can build applications for, deploy them to, and run them on - the desktop environment or a \l{glossary-device}{device}. - \l{glossary-buildandrun-kit}{Kits}, build, run, and deployment - settings allow you to quickly switch between different setups and - target platforms. - - For more information, see \l{Build and Run} - {How To: Build and Run}. - \li \b {\l{Testing}} - - \QC integrates several external native debuggers that you can use - to inspect the state of your application while debugging. - - Devices have limited memory and CPU power, so you should use them - carefully. \QC integrates code analysis tools for detecting - memory leaks, profiling function execution, analyzing CPU use, - and eliminating unnecessary complexity of code. Other tools - provide code coverage and visualize trace events. - - \QC integrates several testing frameworks for unit testing - applications and libraries. You can use \QC to create, build, - and run autotests. - - For more information, see \l{Testing}. - \li \b {Publishing} - - \QC enables you to create installation packages for mobile - devices that you can publish to application stores - and other channels. You must make sure that the package contents - meet the requirements for publishing on the channel. - - For more information, see \l{Publishing to Google Play}. -\endtable + project, designing a UI, and writing code to building applications and + deploying them to the target platforms for running and debugging. + + \image qt-app-dev-flow.webp {Application development life-cycle} + \caption Application development life-cycle + + \section1 Projects + + First, you need a \e project. \QC relies on a separate build system, such as + CMake, qmake, or Qbs for building the project. From the build system, \QC + gets most of the information it needs to offer services for writing, editing, + and navigating source code, as well as to deploy and run applications. It + stores additional information in the project settings. + + Share projects with other designers and developers across different + development platforms with a common tool for design, development, and + debugging. + + \list + \li \l{Creating Projects} + + To set up a project, you first have to decide what kind + of an application you want to develop: do you want a user + interface based on \l{User Interfaces} + {Qt Quick or Qt Widgets}. Second, you have to choose the + programming language to implement the application logic: + C++ or Python. + \li \l{Version Control Systems} + + The recommended way to set up a project is to use a + version control system. Store and edit only project + source files and configuration files. Do not store + generated files. + \li \l{Configuring Projects} + + Installation programs and project wizards create default + configurations for \QC and your projects. Change the + configurations in the \uicontrol Projects mode. + \endlist + + For more information, see \l{Manage Projects}{How To: Manage Projects}. + + \section1 User Interfaces + + \image heartgame-start.webp {Heart Rate Game} + + To create intuitive, modern-looking, fluid user interfaces, use \l{Qt Quick} + and \l{Qt Design Studio Manual}{\QDS}: + + \list + \li \l {\QMLD} + + Or, enable the \QMLD plugin to visually edit \l{UI Files}{UI files} + (.ui.qml). + \li \l {Converting UI Projects to Applications} + + Qt Quick UI Prototype projects (.qmlproject) are useful + for creating user interfaces. To use them for application + development, you have to convert them to Qt Quick + Application projects that have project configuration + files (CMakeLists.txt or .pro), .cpp, and .qrc files. + \li \l {UI Files} + + If you switch between \QC and \QDS or cooperate with + designers on a project, you might encounter .ui.qml files. + They are intended to be edited in \QDS only, so you need + to be careful not to break the code. To visually edit the + files in \QC, enable the \QMLD plugin. + \li \l{Using QML Modules with Plugins} + + Load C++ plugins for QML to simulate data. + \endlist + + If you need a traditional user interface that has a clear structure and + enforces a platform look and feel, use \l{Qt Widgets} and the integrated + \l{\QD}. + + For more information, see \l{Design UIs}{How To: Design UIs} and + \l{UI Design}. + + \section1 Code + + Writing, editing, and navigating in source code are core tasks in application + development. Therefore, the code editor is one of the key components of \QC. + Use the code editor in the \l {Edit Mode}{Edit mode}. + + As an IDE, \QC differs from a text editor in that it knows how to build and + run applications. It understands the C++ and QML languages as code, not just + as plain text. Therefore, it can offer useful features, such as semantic + highlighting, checking code syntax, code completion, and refactoring actions. + + \QC supports some of these services also for other programming languages, + such as Python, for which a \e {language server} is available that provides + information about the code to IDEs. + + \section2 Find + + Use the incremental and advanced search to search in currently open projects + or files on the file system or use the locator to browse through projects, + files, classes, functions, documentation, and file systems. + + \section2 Refactor + + \e {Code refactoring} is the process of improving and simplifying code + without modifying the existing functionality of an application. Find + and rename symbols and apply predefined actions to refactor code. + + Refactor code to: + + \list + \li Improve internal quality of your application + \li Improve performance and extensibility + \li Improve code readability and maintainability + \li Simplify code structure + \endlist + + \section2 Configure the Editor + + Configure the text editor to suit your specific needs. Change the fonts, + colors, highlighting, and indentation. + + If you are used to the Vim editor, run the main editor in the + \l {FakeVim Modes and Commands}{FakeVim mode}. + + For more information, see \l{Edit Code}{How To: Edit Code} and \l{Editors}. + + \section1 Build, Deploy, and Run + + Run and deploy Qt applications that you build for different target + platforms or with different compilers, debuggers, or Qt versions. + \l{glossary-buildandrun-kit}{Kits} define the tools, \l{glossary-device} + {device} type and other settings to use when building and running your + project. + + \QC integrates cross-platform systems for build automation: CMake, + qmake, Qbs, and Autotools. In addition, you can import projects as + \e {generic projects} and fully control the steps and commands to + build the project. + + Build applications for, deploy them to, and run them on the desktop + environment or a device. With kits, as well as build, run, and deployment + configurations, you can quickly switch between different setups and + target platforms. + + For more information, see \l{Build and Run}{How To: Build and Run}, + \l{Build Systems}, \l{Build Configurations}, and \l{Run Configurations}. + + \section2 On Devices + + When you install tool chains for device types as part of a Qt distribution, + the build and run configurations for the devices might be set up + automatically. However, you might need to install and configure some + additional software on the devices to be able to connect to them + from the computer. + + Deployment configurations handle the packaging and copying of the necessary + files to a location you want to run the executable at, such as the file + system of a device. + + For more information, see \l{Connecting Devices} and \l{Deploying to Devices}. + + \section2 Preview QML + + Use the QML live preview to preview a QML file or an entire Qt Quick + application on the desktop, as well as on Android and embedded Linux + devices. The changes you make to the UI are instantly visible to you + in the preview. + + For more information, see \l{Validating with Target Hardware}. + + \section1 Debug + + A debugger lets you see what happens \e inside an application while it runs + or when it crashes. A debugger can do the following to help you find errors + in the application: + + \list + \li Start the application with parameters that specify its behavior. + \li Stop the application when conditions are met. + \li Examine what happens when the application stops. + \li Make changes in the application when you fix an error and continue + to find the next one. + \endlist + + \QC integrates several external native debuggers for inspecting the state of + your application while debugging. The debugger plugin automatically selects + a suitable native debugger for each kit from the ones it finds on the + computer. Edit the kits to override this choice. + + Connect devices to your computer to debug processes running on the devices. + + For more information, see \l{Debugging}. + + \section1 Analyze + + Devices have limited memory and CPU power, so you should use them carefully. + \QC integrates code analysis tools for detecting memory leaks, profiling + function execution, analyzing CPU use, and eliminating unnecessary complexity + of code. Other tools provide code coverage and visualize trace events. + + Install and configure the tools on your system to use them from \QC. + However, the QML Profiler is installed as part of \QC for profiling + Qt Quick applications. + + For more information, see \l{Analyzing Code}. + + \section1 Autotest + + Create, build and run Qt tests, Qt Quick tests, Google tests, and Boost tests + to unit test applications and libraries. + + Map AUTs (Application Under Test) to \QC and run Squish test suites + and cases from it. + + For more information, see \l{Running Autotests} and \l{Using Squish}. + + \section1 Publish + + Create installation packages for mobile devices that you publish to + application stores and other channels. You must make sure that the + package contents meet the requirements for publishing on the channel. + + For more information, see \l{Publishing to Google Play}. + + \section1 Qt Tools + + \QC is one of many Qt tools for designing and developing applications. + \image qt-tools.webp {Tools for Qt application development} + \caption Tools for Qt application development */ diff --git a/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc b/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc index ec77c0c54a..26ef6701d6 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc @@ -20,7 +20,7 @@ \li \l{Debugging} - If you install \QC as part of \QSDK, the GNU Symbolic Debugger + If you install \QC with \QOI, 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 diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 9038a16807..933fadb3a0 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -15,7 +15,7 @@ \list \li \l{Getting Started} \list - \li \l{IDE Overview} + \li \l{Overview} \list \li \l{Creating Projects} \li \l{Configuring Projects} diff --git a/doc/qtcreator/src/qtcreator.qdoc b/doc/qtcreator/src/qtcreator.qdoc index 85c60896ac..eaceebf177 100644 --- a/doc/qtcreator/src/qtcreator.qdoc +++ b/doc/qtcreator/src/qtcreator.qdoc @@ -41,7 +41,7 @@ \row \li \b {\l{Getting Started}} \list - \li \l{IDE Overview} + \li \l{Overview} \li \l{User Interface} \li \l{Configuring Qt Creator} \li \l{Building and Running an Example} |