Skip to content

Commit

Permalink
Doc: Improve info on debugging Qt apps
Browse files Browse the repository at this point in the history
- Add a screenshot of the process with numbers
- Add a link to VS Code debugging information
- Mention checking and selecting launch target
- List and describe the available Qt debug configurations
  • Loading branch information
leena-miettinen committed Jan 9, 2025
1 parent 38af8c5 commit 4416f65
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 3 deletions.
Binary file added doc/images/vscode-run-and-debug.webp
Binary file not shown.
4 changes: 4 additions & 0 deletions doc/src/externallinks.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@
\externalpage https://doc.qt.io/index.html
\title Qt Documentation
*/
/*!
\externalpage https://code.visualstudio.com/Docs/editor/debugging
\title VS Code: Debugging
*/
2 changes: 1 addition & 1 deletion doc/src/how-to/vscodeext-how-to-debug-apps-wasm.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
\list 1
\li Open a \e {launch.json} file.
\li Select \uicontrol {Add Configuration}, and then select the
\uicontrol {Qt:Debug Qt WASM with Chrome} debug configuration.
\uicontrol {Qt: Debug Qt WASM with Chrome} debug configuration.
\endlist

The \uicontrol {Qt: WASM Start} task in the \uicontrol {preLaunchTask}
Expand Down
24 changes: 22 additions & 2 deletions doc/src/how-to/vscodeext-how-to-debug-apps.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,29 @@
\list 1
\li Go to \uicontrol {Run and Debug} (\key {Ctrl+Shift+V} or
\key {Cmd+Shift+V} on \macos).
\li Create a \e {launch.json} file.
\li Select \uicontrol {Add Configuration}, and then select a
\image vscode-run-and-debug.webp {Run and Debug in VS Code}
\li Create a \e {launch.json} file (1) that contains launch configurations.
For more information, see \l{VS Code: Debugging} in the VS Code
documentation.
\li Select \uicontrol {Add Configuration} (2), and then select a
\uicontrol {Qt: Debug} debug configuration that matches
your debugger.
\li Check the launch target (3). To change it, select the
target name or go to \uicontrol {Command Palette} and
select \uicontrol {CMake: Set Launch/Debug Target}.
\endlist

Select one of the following Qt debug configurations:

\list
\li \uicontrol {Qt: Debug with cppdbg} for debugging C/C++ applications
with GDB.
\li \uicontrol {Qt: Debug with cppvsdbg} for debugging C/C++
applications with the Visual Studio Windows debugger.
\li \uicontrol {Qt: Debug with lldb} for debugging with LLDB.
\li \uicontrol {Qt: Debug Qt WASM with Chrome} for debugging
Qt WebAssembly applications with Chrome.
\endlist

\sa {Debug Qt WebAssembly applications}
*/

0 comments on commit 4416f65

Please sign in to comment.