QmlDesigner: Create a document for the new output view

This patch creates a document to introduce the new
output view.

Fixes: QDS-13733
Change-Id: Ide45cdcb606e0739bf500df49aa7cd32ee2485c3
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
This commit is contained in:
Pranta Dastider
2024-12-02 13:56:57 +01:00
committed by Pranta Ghosh Dastider
parent e2b0bac625
commit f8ee1dd76e
14 changed files with 69 additions and 7 deletions

View File

@@ -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
// **********************************************************************
@@ -11,7 +11,7 @@
\page creator-editor-external.html
\if defined(qtdesignstudio)
\previouspage creator-vcs-git.html
\nextpage studio-on-mcus.html
\nextpage studio-accessing-output-issues-and-warnings.html
\else
\previouspage creator-how-tos.html
\endif

View File

@@ -124,9 +124,10 @@
<ul>
<li><a>Debugging and profiling</a>
<ul>
<li><a href="creator-qml-debugging-example.html">Debugging Qt Quick applications</a></li>
<li><a href="creator-debugging-qml.html">Debugging Qt Quick projects</a></li>
<li><a href="creator-qml-performance-monitor.html">Profiling QML applications</a></li>
<li><a href="studio-accessing-output-issues-and-warnings.html">Accessing output, issue, and warning messages</a></li>
<li><a href="creator-qml-debugging-example.html">Debugging Qt Quick Applications</a></li>
<li><a href="creator-debugging-qml.html">Debugging Qt Quick Projects</a></li>
<li><a href="creator-qml-performance-monitor.html">Profiling QML Applications</a></li>
</ul>
</li>
</ul>

Binary file not shown.

After

Width:  |  Height:  |  Size: 257 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 206 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 261 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

View File

@@ -0,0 +1,54 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page studio-accessing-output-issues-and-warnings.html
\nextpage studio-on-mcus.html
\previouspage creator-editor-external.html
\title Accessing output, issue, and warning messages
\image studio-output-view.webp Qt Design Studio Output view
\QDS projects generate output information that represent the
executed processes. It also shows you the issues that stop a project from
getting executed or gives you warnings about probable failures. Warning messages
generated in the \uicontrol Issues relate to the code and design problems,
and warning messages generated in the \uicontrol Output relate to the
runtime failures.
\section1 Accessing the Output messages
When you run a project, details about the runtime execution processes
is listed in the output view. To access these messages, select
\inlineimage icons/output.png {Output}.
\image studio-output-view-message.webp Runtime execution process related output messages
\section1 Accessing the Issue and Warning messages
Technical problems in the \QDS project are visible in the
\uicontrol Output view. To access these issues,
select \inlineimage icons/warning.png {Warning} \inlineimage icons/error.png {Error}.
Select the \e filename from the issue notification to jump into the location of the error.
It takes you to the location of the issue in the view (\uicontrol 2D, \uicontrol 3D, or
\uicontrol Code) you are currently in.
\table
\header
\li Message type
\li Message example
\row
\li Issue notification
\li \image studio-issue-message.webp
\row
\li Warning notification
\li \image studio-warning-message.webp
\endtable
To clear the \uicontrol Output view, select \inlineimage icons/clear-view.png {Clear}.
To close the \uicontrol Output view, select \inlineimage icons/distribute-origin-none.png {Close}.
*/

View File

@@ -1,8 +1,8 @@
// 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
/*!
\previouspage creator-editor-external.html
\previouspage studio-accessing-output-issues-and-warnings.html
\page studio-on-mcus.html
\nextpage studio-mcu-framework.html

View File

@@ -35,5 +35,11 @@
QML utilities, the default text editor for your system, and the
\c sort tool are preconfigured for use. You can change their default
configurations and configure new tools.
\li \l{Accessing output, issue, and warning messages}
\QDS projects generate output information for the user to represent the
executed processes. It also shows you the issues that stop a project from
getting executed or gives you warnings about probable failures.
\endlist
*/

View File

@@ -229,6 +229,7 @@
\li \l{Finding the Qt Runtime Version}
\li \l{Using Git}
\li \l{Use external tools}
\li \l{Accessing output, issue, and warning messages}
\li \l{\QDS on MCUs}
\list
\li \l {\QMCU Framework}