From 605f9413aaff43dfcd6de47c247295d5d13eb568 Mon Sep 17 00:00:00 2001 From: Jaishree Vyas Date: Thu, 30 Nov 2023 12:02:00 +0100 Subject: [PATCH] Doc: Rearrange best practices and how to documentation Change the best practices to how-tos, which are categorized now on a new page. Fixes: QTBUG-118044 Pick-to: 6.6 6.5 Change-Id: I78dba2a1fde03b346f110ecd54e11485a0869540 Reviewed-by: Leena Miettinen (cherry picked from commit 7372b3ab6748b68f1c5fba1f61df8083ce719bc5) Reviewed-by: Qt Cherry-pick Bot --- src/corelib/doc/src/custom-types.qdoc | 2 +- src/corelib/doc/src/timers.qdoc | 2 +- src/dbus/doc/src/dbus-adaptors.qdoc | 2 +- src/gui/doc/src/richtext.qdoc | 1 - 4 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/corelib/doc/src/custom-types.qdoc b/src/corelib/doc/src/custom-types.qdoc index d9da3d65e53..7922fd94772 100644 --- a/src/corelib/doc/src/custom-types.qdoc +++ b/src/corelib/doc/src/custom-types.qdoc @@ -6,7 +6,7 @@ \title Creating Custom Qt Types \brief How to create and register new types with Qt. - \ingroup best-practices + \ingroup how-to \tableofcontents diff --git a/src/corelib/doc/src/timers.qdoc b/src/corelib/doc/src/timers.qdoc index e13baa6eec5..6bd35255d53 100644 --- a/src/corelib/doc/src/timers.qdoc +++ b/src/corelib/doc/src/timers.qdoc @@ -6,7 +6,7 @@ \title Timers \brief How to use Qt timers in your application. - \ingroup best-practices + \ingroup how-to QObject, the base class of all Qt objects, provides the basic timer support in Qt. With QObject::startTimer(), you start a diff --git a/src/dbus/doc/src/dbus-adaptors.qdoc b/src/dbus/doc/src/dbus-adaptors.qdoc index 4c4369217bf..66035267433 100644 --- a/src/dbus/doc/src/dbus-adaptors.qdoc +++ b/src/dbus/doc/src/dbus-adaptors.qdoc @@ -6,7 +6,7 @@ \title Using Qt D-Bus Adaptors \brief How to create and use DBus adaptors in Qt. - \ingroup best-practices + \ingroup how-to Adaptors are special classes that are attached to any QObject-derived class and provide the interface to the external world using D-Bus. Adaptors are diff --git a/src/gui/doc/src/richtext.qdoc b/src/gui/doc/src/richtext.qdoc index 9aa4d450b80..10d99628500 100644 --- a/src/gui/doc/src/richtext.qdoc +++ b/src/gui/doc/src/richtext.qdoc @@ -14,7 +14,6 @@ \ingroup explanations-ui \ingroup frameworks-technologies \ingroup qt-basic-concepts - \ingroup best-practices \nextpage Rich Text Document Structure