From 1a8ae82bb02120c6128eb720072daf8acda5bd2b Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 15 Jan 2025 15:35:27 +0100 Subject: [PATCH] Qt D-Bus Viewer: Update documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit -Added information about the location of qdbusviewer -Fix name to "Qt D-Bus Viewer" Fixes: QTBUG-118997 Pick-to: 6.8 6.9 Change-Id: I90f1e75a04a959d9c739e33779d978b607a8181c Reviewed-by: Topi Reiniö Reviewed-by: Ralf Habacker Reviewed-by: Kai Köhne --- src/dbus/doc/src/qtdbus-index.qdoc | 14 ++++++++++++-- src/dbus/doc/src/qtdbus-toc.qdoc | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/dbus/doc/src/qtdbus-index.qdoc b/src/dbus/doc/src/qtdbus-index.qdoc index 93f1cc6b895..4b00b15c039 100644 --- a/src/dbus/doc/src/qtdbus-index.qdoc +++ b/src/dbus/doc/src/qtdbus-index.qdoc @@ -44,7 +44,7 @@ \li \l {Using Qt D-Bus Adaptors} \li \l {The Qt D-Bus Type System} \li \l {Qt D-Bus XML compiler (qdbusxml2cpp)} - \li \l{D-Bus Viewer} + \li \l {Qt D-Bus Viewer} \endlist \section1 Examples @@ -81,7 +81,7 @@ /*! \page qdbusviewer.html - \title D-Bus Viewer + \title Qt D-Bus Viewer \keyword qdbusviewer The Qt D-Bus Viewer (\c {qdbusviewer}) is a tool that lets you introspect D-Bus objects and messages. You can @@ -93,4 +93,14 @@ Right-click on a signal to connect to it. All emitted signals including their parameters are output in the message view on the lower side of the window. + + \section1 Running Qt D-Bus Viewer + + To run Qt D-Bus Viewer, execute the \c qdbusviewer tool in the installation + directory of the respective Qt version. For the Qt \QtVersion Linux/X11 + installation using the \QOI, the tool is at: + + \badcode \QtVersion + /\1/gcc_64/bin/qdbusviewer + \endcode */ diff --git a/src/dbus/doc/src/qtdbus-toc.qdoc b/src/dbus/doc/src/qtdbus-toc.qdoc index 0d951cc77f2..64355c9398f 100644 --- a/src/dbus/doc/src/qtdbus-toc.qdoc +++ b/src/dbus/doc/src/qtdbus-toc.qdoc @@ -17,7 +17,7 @@ \li \l{The Qt D-Bus Type System} \endlist \li \l {Qt D-Bus XML compiler (qdbusxml2cpp)} - \li \l {D-Bus Viewer} + \li \l {Qt D-Bus Viewer} \li \l {CMake Commands in Qt6 DBus} \li \l {CMake Source File Properties in Qt6 DBus} \li \l {Changes to Qt D-Bus}{Upgrading from Qt 5}