Doc: List Tutorials as a separate category on the front page

Add the following topics to the creator-tutorials group:

- Building and Running an Example
- Debugging a C++ Example Application

Task-number: QTCREATORBUG-29361
Change-Id: Ib6de92e99caf552ee8337b49af48bd04d6760474
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2024-03-14 13:45:50 +01:00
parent 9fa1dbcd3c
commit 4fa5422026
10 changed files with 57 additions and 44 deletions

View File

@@ -12,27 +12,34 @@
<li><a href="creator-overview.html">Overview</a></li> <li><a href="creator-overview.html">Overview</a></li>
<li><a href="creator-quick-tour.html">User Interface</a></li> <li><a href="creator-quick-tour.html">User Interface</a></li>
<li><a href="creator-configuring.html">Configuring Qt Creator</a></li> <li><a href="creator-configuring.html">Configuring Qt Creator</a></li>
<li><a href="creator-build-example-application.html">Building and Running an Example</a></li>
<li><a href="creator-tutorials.html">Tutorials</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div class="sectionlist normallist"> <div class="sectionlist normallist">
<div class="heading"> <div class="heading">
<h2>Coding</h2> <h2>Tutorials</h2>
</div>
<div class="indexboxcont indexboxbar">
<ul>
<li><a href="creator-tutorial-adding-internal-libraries-to-projects.html">Adding an Internal Library to a qmake Project</a></li>
<li><a href="creator-build-example-application.html">Building and Running an Example</a></li>
<li><a href="qtcreator-accelbubble-example.html">Creating a Mobile Application</a></li>
<li><a href="qtcreator-transitions-example.html">Creating a Qt Quick Application</a></li>
<li><a href="creator-writing-program.html">Creating a Qt Widget Based Application</a></li>
<li><a href="creator-tutorial-python-application-qt-quick.html">Creating a Qt for Python Application with Qt Quick</a></li>
<li><a href="creator-tutorial-python-application-widgets.html">Creating a Qt for Python Application with Qt Widgets</a></li>
<li><a href="creator-debugging-example.html">Debugging a C++ Application</a></li>
<li><a href="creator-qml-debugging-example.html">Debugging a Qt Quick Application</a></li>
<li><a href="creator-tutorials.html">See All</a></li>
</ul>
</div> </div>
<ul>
<li><a href="creator-editor-functions.html">Writing Code</a></li>
<li><a href="creator-editor-options.html">Configuring the Editor</a></li>
</ul>
</div> </div>
<div class="sectionlist normallist"> <div class="sectionlist normallist">
<div class="heading"> <div class="heading">
<h2>Building and Running</h2> <h2>Running on Devices</h2>
</div> </div>
<ul> <ul>
<li><a href="creator-live-preview.html">Validating with Target Hardware</a></li> <li><a href="creator-live-preview.html">Validating with Target Hardware</a></li>
<li><a href="creator-building-targets.html">Building for Multiple Platforms</a></li>
<li><a href="creator-deployment.html">Deploying to Devices</a></li> <li><a href="creator-deployment.html">Deploying to Devices</a></li>
<li><a href="creator-connecting-mobile.html">Connecting Devices</a></li> <li><a href="creator-connecting-mobile.html">Connecting Devices</a></li>
</ul> </ul>

View File

@@ -8,28 +8,32 @@
// ********************************************************************** // **********************************************************************
/*! /*!
\previouspage creator-debugging-qml.html
\page creator-debugging-example.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 example to illustrate how to debug Qt C++ applications in the
\uicontrol Debug mode. \uicontrol Debug mode.
TextFinder reads a text file into QString and then displays it with 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 QTextEdit. To look at the TextFinder class and see the stored data:
a breakpoint in textfinder.cpp, as follows:
\list 1 \list 1
\li Click in between the line number and the window border on the line \li In textfinder.cpp, click between the line number and the window
where we change the cursor position to set a breakpoint. border on the line where we change the cursor position to set a
breakpoint.
\image qtcreator-setting-breakpoint1.png \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. \uicontrol {Start Debugging of Startup Project} or press \key F5.
\li To view information about the breakpoint, go to the \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 Into}), and \inlineimage icons/debugger_stepout_small.png
(\uicontrol {Step Out}). (\uicontrol {Step Out}).
\sa {Creating a Qt Widget Based Application}, {Debugging}
*/ */

View File

@@ -90,11 +90,11 @@
objects and user interfaces, as well as execute JavaScript objects and user interfaces, as well as execute JavaScript
expressions. expressions.
\li \l{Debugging a C++ Example Application} \li \l{Debugging a C++ Application}
Illustrates how to debug C++ applications in \QC. 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. Illustrates how to debug Qt Quick applications in \QC.

View File

@@ -13,14 +13,17 @@
\previouspage creator-expressions-view.html \previouspage creator-expressions-view.html
\nextpage creator-qml-performance-monitor.html \nextpage creator-qml-performance-monitor.html
\else \else
\previouspage creator-debugging-example.html \previouspage creator-tutorials.html
\nextpage creator-troubleshooting-debugging.html \nextpage creator-how-tos.html
\endif \endif
\title Debugging a Qt Quick Example Application \ingroup creator-tutorials
This section uses the \title Debugging a Qt Quick Application
\l{QML Advanced Tutorial}{Same Game}
\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 example application to illustrate how to debug Qt Quick applications in the
\uicontrol Debug mode. \uicontrol Debug mode.
@@ -28,7 +31,7 @@
\l{Debugging Qt Quick Projects}. \l{Debugging Qt Quick Projects}.
\if defined(qtdesignstudio) \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 visible by default. To toggle the visibility of advanced menu items, see
\l{Customizing the Menu}. \l{Customizing the Menu}.
@@ -107,4 +110,5 @@
\endlist \endlist
\sa {Debugging Qt Quick Projects}
*/ */

View File

@@ -24,7 +24,7 @@
\endif \endif
For an example of how to debug Qt Quick Projects, see 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) \if defined(qtdesignstudio)
\note In this section, you are using advanced menu items. These are not \note In this section, you are using advanced menu items. These are not

View File

@@ -8,13 +8,17 @@
// ********************************************************************** // **********************************************************************
/*! /*!
\previouspage creator-configuring.html
\page creator-build-example-application.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 \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. example application project.
To run an example application on an Android or iOS device, you must set up To run an example application on an Android or iOS device, you must set up

View File

@@ -22,9 +22,9 @@
\endlist \endlist
\li \l{User Interface} \li \l{User Interface}
\li \l{Configuring Qt Creator} \li \l{Configuring Qt Creator}
\li \l{Building and Running an Example}
\li \l{Tutorials}
\endlist \endlist
\li \l{Tutorials}
\generatelist creator-tutorials
\li \l{Coding} \li \l{Coding}
\list \list
\li \l{Writing Code} \li \l{Writing Code}
@@ -86,8 +86,6 @@
\li \l{Debugger Preferences} \li \l{Debugger Preferences}
\li \l{Using Debugging Helpers} \li \l{Using Debugging Helpers}
\li \l{Debugging Qt Quick Projects} \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} \li \l{Troubleshooting Debugger}
\endlist \endlist
\li \l{Analyzing Code} \li \l{Analyzing Code}

View File

@@ -14,7 +14,7 @@
\title Qt Creator Manual \title Qt Creator Manual
\QC is a cross-platform, complete integrated development environment \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{Desktop Platforms}{desktop}, \l {Embedded Platforms}{embedded}, and
\l{Mobile Platforms}{mobile device} platforms, such as \l Android 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 \l iOS. It is available for \l Linux, \l \macos and \l Windows
@@ -38,14 +38,9 @@
\li \l{Overview} \li \l{Overview}
\li \l{User Interface} \li \l{User Interface}
\li \l{Configuring Qt Creator} \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 \endlist
\li \b {\l{Tutorials}}
\generatelist creator-tutorials
\li \b {\l{Running on Devices}} \li \b {\l{Running on Devices}}
\list \list
\li \l{Validating with Target Hardware} \li \l{Validating with Target Hardware}

View File

@@ -15,7 +15,7 @@
to execute JavaScript expressions to get information about the state to execute JavaScript expressions to get information about the state
of the UI, and to inspect QML properties and JavaScript of the UI, and to inspect QML properties and JavaScript
variables and change them temporarily at runtime. 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 This section uses the \l{QML Advanced Tutorial}{Same Game} example
application to illustrate how to debug Qt Quick applications in the application to illustrate how to debug Qt Quick applications in the

View File

@@ -229,7 +229,7 @@
\li \l{Local Variables and Function Parameters} \li \l{Local Variables and Function Parameters}
\li \l{Evaluating Expressions} \li \l{Evaluating Expressions}
\endlist \endlist
\li \l{Debugging a Qt Quick Example Application} \li \l{Debugging a Qt Quick Application}
\li \l{Profiling QML Applications} \li \l{Profiling QML Applications}
\endlist \endlist
\endlist \endlist