diff --git a/doc/qtcreator/config/style/qt5-sidebar.html b/doc/qtcreator/config/style/qt5-sidebar.html index a9e8acad864..c5ecac11af4 100644 --- a/doc/qtcreator/config/style/qt5-sidebar.html +++ b/doc/qtcreator/config/style/qt5-sidebar.html @@ -12,27 +12,34 @@
  • Overview
  • User Interface
  • Configuring Qt Creator
  • -
  • Building and Running an Example
  • -
  • Tutorials
  • -

    Coding

    +

    Tutorials

    +
    +
    +
    -
    -

    Building and Running

    +

    Running on Devices

    diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc index 95433c1ad96..ccc9e82fd1b 100644 --- a/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc +++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc @@ -8,28 +8,32 @@ // ********************************************************************** /*! - \previouspage creator-debugging-qml.html \page creator-debugging-example.html - \nextpage creator-qml-debugging-example.html + \previouspage creator-tutorials.html + \nextpage creator-how-tos.html - \title Debugging a C++ Example Application + \ingroup creator-tutorials - This section uses the \l{Creating a Qt Widget Based Application}{TextFinder} + \title Debugging a C++ Application + + \brief How to debug a C++ application. + + This tutorial uses the \l{Creating a Qt Widget Based Application}{TextFinder} example to illustrate how to debug Qt C++ applications in the \uicontrol Debug mode. TextFinder reads a text file into QString and then displays it with - QTextEdit. To look at the TextFinder class and see the stored data, place - a breakpoint in textfinder.cpp, as follows: + QTextEdit. To look at the TextFinder class and see the stored data: \list 1 - \li Click in between the line number and the window border on the line - where we change the cursor position to set a breakpoint. + \li In textfinder.cpp, click between the line number and the window + border on the line where we change the cursor position to set a + breakpoint. \image qtcreator-setting-breakpoint1.png - \li Select \uicontrol Debug > \uicontrol {Start Debugging} > + \li Go to \uicontrol Debug > \uicontrol {Start Debugging} > \uicontrol {Start Debugging of Startup Project} or press \key F5. \li To view information about the breakpoint, go to the @@ -91,4 +95,5 @@ (\uicontrol {Step Into}), and \inlineimage icons/debugger_stepout_small.png (\uicontrol {Step Out}). + \sa {Creating a Qt Widget Based Application}, {Debugging} */ diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc index 35bd896dff2..d3441ab0630 100644 --- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc +++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc @@ -90,11 +90,11 @@ objects and user interfaces, as well as execute JavaScript expressions. - \li \l{Debugging a C++ Example Application} + \li \l{Debugging a C++ Application} Illustrates how to debug C++ applications in \QC. - \li \l{Debugging a Qt Quick Example Application} + \li \l{Debugging a Qt Quick Application} Illustrates how to debug Qt Quick applications in \QC. diff --git a/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc b/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc index 797788897ac..614219ce634 100644 --- a/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc +++ b/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc @@ -13,14 +13,17 @@ \previouspage creator-expressions-view.html \nextpage creator-qml-performance-monitor.html \else - \previouspage creator-debugging-example.html - \nextpage creator-troubleshooting-debugging.html + \previouspage creator-tutorials.html + \nextpage creator-how-tos.html \endif - \title Debugging a Qt Quick Example Application + \ingroup creator-tutorials - This section uses the - \l{QML Advanced Tutorial}{Same Game} + \title Debugging a Qt Quick Application + + \brief How to debug a Qt Quick application. + + This tutorial uses the \l{QML Advanced Tutorial}{Same Game} example application to illustrate how to debug Qt Quick applications in the \uicontrol Debug mode. @@ -28,7 +31,7 @@ \l{Debugging Qt Quick Projects}. \if defined(qtdesignstudio) - \note In this section, you are using advanced menu items. These are not + \note In this tutorial, you are using advanced menu items. These are not visible by default. To toggle the visibility of advanced menu items, see \l{Customizing the Menu}. @@ -107,4 +110,5 @@ \endlist + \sa {Debugging Qt Quick Projects} */ diff --git a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc index c888927e022..325e53bc3f9 100644 --- a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc +++ b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc @@ -24,7 +24,7 @@ \endif For an example of how to debug Qt Quick Projects, see - \l{Debugging a Qt Quick Example Application}. + \l{Debugging a Qt Quick Application}. \if defined(qtdesignstudio) \note In this section, you are using advanced menu items. These are not diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc index 77e9263a323..ac06f8cbd1e 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc @@ -8,13 +8,17 @@ // ********************************************************************** /*! - \previouspage creator-configuring.html \page creator-build-example-application.html - \nextpage creator-tutorials.html + \previouspage creator-tutorials.html + \nextpage creator-how-tos.html + + \ingroup creator-tutorials \title Building and Running an Example - You can test that your \QSDK installation is successful by opening an existing + \brief How to build and run a Qt example. + + To test that your \QOI installation is successful, open an existing example application project. To run an example application on an Android or iOS device, you must set up diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 0f9984b3c93..47e0c9981dc 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -22,9 +22,9 @@ \endlist \li \l{User Interface} \li \l{Configuring Qt Creator} - \li \l{Building and Running an Example} - \li \l{Tutorials} \endlist + \li \l{Tutorials} + \generatelist creator-tutorials \li \l{Coding} \list \li \l{Writing Code} @@ -86,8 +86,6 @@ \li \l{Debugger Preferences} \li \l{Using Debugging Helpers} \li \l{Debugging Qt Quick Projects} - \li \l{Debugging a C++ Example Application} - \li \l{Debugging a Qt Quick Example Application} \li \l{Troubleshooting Debugger} \endlist \li \l{Analyzing Code} diff --git a/doc/qtcreator/src/qtcreator.qdoc b/doc/qtcreator/src/qtcreator.qdoc index 0e8b476b40e..bb83726951f 100644 --- a/doc/qtcreator/src/qtcreator.qdoc +++ b/doc/qtcreator/src/qtcreator.qdoc @@ -14,7 +14,7 @@ \title Qt Creator Manual \QC is a cross-platform, complete integrated development environment - (IDE) for application developers to create applications for multiple + (IDE) that you can use to create applications for \l{Desktop Platforms}{desktop}, \l {Embedded Platforms}{embedded}, and \l{Mobile Platforms}{mobile device} platforms, such as \l Android and \l iOS. It is available for \l Linux, \l \macos and \l Windows @@ -38,14 +38,9 @@ \li \l{Overview} \li \l{User Interface} \li \l{Configuring Qt Creator} - \li \l{Building and Running an Example} - \li \l{Tutorials} - \endlist - \li \b {\l{Coding}} - \list - \li \l{Writing Code} - \li \l{Configuring the Editor} \endlist + \li \b {\l{Tutorials}} + \generatelist creator-tutorials \li \b {\l{Running on Devices}} \list \li \l{Validating with Target Hardware} diff --git a/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc index 19d3fa0b8ba..85823a8dfa0 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc @@ -15,7 +15,7 @@ to execute JavaScript expressions to get information about the state of the UI, and to inspect QML properties and JavaScript variables and change them temporarily at runtime. - \li \l{Debugging a Qt Quick Example Application} + \li \l{Debugging a Qt Quick Application} This section uses the \l{QML Advanced Tutorial}{Same Game} example application to illustrate how to debug Qt Quick applications in the diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 7d4b5d2521e..c367b6840be 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -229,7 +229,7 @@ \li \l{Local Variables and Function Parameters} \li \l{Evaluating Expressions} \endlist - \li \l{Debugging a Qt Quick Example Application} + \li \l{Debugging a Qt Quick Application} \li \l{Profiling QML Applications} \endlist \endlist