From 4cdf4487ad8d8f2175802c886395cc3f98dd3e2a Mon Sep 17 00:00:00 2001 From: Jaishree Vyas Date: Wed, 16 Aug 2023 11:49:32 +0200 Subject: [PATCH] Doc: All overviews list categorization MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The \generate list names are added for each categorized section with some explanation. Here, calling the overviews as explanations-(name of the section). The idea is to give general terms instead of specific phrases like 'core' etc, for better understanding. Task-number: QTBUG-115347 Change-Id: I673e38c0e9193b7f7d54008bfcf82c2d3a10be3f Reviewed-by: Topi Reiniƶ (cherry picked from commit 29eb5d8ace744cd4a946aca3f5f1ffe0f4bd0a1f) Reviewed-by: Qt Cherry-pick Bot (cherry picked from commit 4b26cb5866c497fe829fd8ab0f4dc4bf7d4c7774) Reviewed-by: Leena Miettinen --- src/corelib/doc/src/cbor.qdoc | 1 + src/corelib/doc/src/json.qdoc | 2 +- src/corelib/doc/src/objectmodel/metaobjects.qdoc | 2 +- src/corelib/doc/src/objectmodel/properties.qdoc | 2 +- src/corelib/doc/src/objectmodel/signalsandslots.qdoc | 1 + src/dbus/doc/src/qtdbus-overview.qdoc | 1 + src/gui/doc/src/richtext.qdoc | 2 +- src/xml/doc/src/xml-processing.qdoc | 1 + 8 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/corelib/doc/src/cbor.qdoc b/src/corelib/doc/src/cbor.qdoc index 1deeb19bb8a..1358480b8a5 100644 --- a/src/corelib/doc/src/cbor.qdoc +++ b/src/corelib/doc/src/cbor.qdoc @@ -6,6 +6,7 @@ \title CBOR Support in Qt \ingroup qt-basic-concepts \brief An overview of CBOR support in Qt. + \ingroup explanations-dataprocessingandio \ingroup frameworks-technologies diff --git a/src/corelib/doc/src/json.qdoc b/src/corelib/doc/src/json.qdoc index 3097075eb90..27959d47147 100644 --- a/src/corelib/doc/src/json.qdoc +++ b/src/corelib/doc/src/json.qdoc @@ -6,7 +6,7 @@ \title JSON Support in Qt \ingroup qt-basic-concepts \brief An overview of JSON support in Qt. - + \ingroup explanations-dataprocessingandio \ingroup frameworks-technologies \keyword JSON diff --git a/src/corelib/doc/src/objectmodel/metaobjects.qdoc b/src/corelib/doc/src/objectmodel/metaobjects.qdoc index 62226ca4668..3d7685447fc 100644 --- a/src/corelib/doc/src/objectmodel/metaobjects.qdoc +++ b/src/corelib/doc/src/objectmodel/metaobjects.qdoc @@ -5,7 +5,7 @@ \page metaobjects.html \title The Meta-Object System \brief An overview of Qt's meta-object system and introspection capabilities. - + \ingroup explanations-basics \ingroup qt-basic-concepts \keyword meta-object \keyword Meta-Object System diff --git a/src/corelib/doc/src/objectmodel/properties.qdoc b/src/corelib/doc/src/objectmodel/properties.qdoc index eef2df70282..93624574d83 100644 --- a/src/corelib/doc/src/objectmodel/properties.qdoc +++ b/src/corelib/doc/src/objectmodel/properties.qdoc @@ -5,7 +5,7 @@ \page properties.html \title The Property System \brief An overview of Qt's property system. - + \ingroup explanations-basics \ingroup qt-basic-concepts \keyword Qt's Property System diff --git a/src/corelib/doc/src/objectmodel/signalsandslots.qdoc b/src/corelib/doc/src/objectmodel/signalsandslots.qdoc index 836fa07a253..a984a8ea3ce 100644 --- a/src/corelib/doc/src/objectmodel/signalsandslots.qdoc +++ b/src/corelib/doc/src/objectmodel/signalsandslots.qdoc @@ -8,6 +8,7 @@ \ingroup qt-basic-concepts \brief An overview of Qt's signals and slots inter-object communication mechanism. + \ingroup explanations-basics Signals and slots are used for communication between objects. The signals and slots mechanism is a central feature of Qt and diff --git a/src/dbus/doc/src/qtdbus-overview.qdoc b/src/dbus/doc/src/qtdbus-overview.qdoc index 1d570b1242e..6342e674fd2 100644 --- a/src/dbus/doc/src/qtdbus-overview.qdoc +++ b/src/dbus/doc/src/qtdbus-overview.qdoc @@ -5,6 +5,7 @@ \page qtdbus-overview.html \title Qt D-Bus Overview \brief Provides insight into the Qt Qt D-Bus module. + \ingroup explanations-networkingandconnectivity D-Bus is an Inter-Process Communication (IPC) and Remote Procedure Calling (RPC) mechanism originally developed for Linux to replace diff --git a/src/gui/doc/src/richtext.qdoc b/src/gui/doc/src/richtext.qdoc index 75b85d3e167..9aa4d450b80 100644 --- a/src/gui/doc/src/richtext.qdoc +++ b/src/gui/doc/src/richtext.qdoc @@ -11,7 +11,7 @@ \page richtext.html \title Rich Text Processing \brief An overview of Qt's rich text processing, editing and display features. - + \ingroup explanations-ui \ingroup frameworks-technologies \ingroup qt-basic-concepts \ingroup best-practices diff --git a/src/xml/doc/src/xml-processing.qdoc b/src/xml/doc/src/xml-processing.qdoc index ad4dadb5838..acca1b070b7 100644 --- a/src/xml/doc/src/xml-processing.qdoc +++ b/src/xml/doc/src/xml-processing.qdoc @@ -15,6 +15,7 @@ /*! \page xml-processing.html \title XML Processing + \ingroup explanations-dataprocessingandio \brief An Overview of the XML processing facilities in Qt.