From 7c344176d21e00a648bb504da735f174f70f0ad2 Mon Sep 17 00:00:00 2001
From: Volker Hilsheimer <volker.hilsheimer@qt.io>
Date: Tue, 16 Jul 2024 11:57:58 +0200
Subject: [PATCH] Doc: link from non-categorized logging API to
 QLoggingCategory

The <QtLogging> documentation page is easily found, and from there it's
not easy to see that categorized logging is a feature. Add more links.

Pick-to: 6.8
Task-number: QTBUG-125589
Change-Id: I214b9a561d6fc6b4c8600bc1b1eca04d856678d6
Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
---
 src/corelib/global/qlogging.cpp | 30 +++++++++++++++++++-----------
 1 file changed, 19 insertions(+), 11 deletions(-)

diff --git a/src/corelib/global/qlogging.cpp b/src/corelib/global/qlogging.cpp
index efeec370943..998eafcbbbc 100644
--- a/src/corelib/global/qlogging.cpp
+++ b/src/corelib/global/qlogging.cpp
@@ -162,6 +162,8 @@ Q_TRACE_POINT(qtcore, qt_message_print, int type, const char *category, const ch
     Example:
 
     \snippet code/src_corelib_global_qglobal.cpp 4
+
+    \sa QLoggingCategory
 */
 
 template <typename String>
@@ -423,6 +425,8 @@ void QMessageLogger::info(const char *msg, ...) const
     with this signature, and \c Q_LOGGING_CATEGORY generates its definition.
 
     \since 5.3
+
+    \sa QLoggingCategory
 */
 
 /*!
@@ -2399,6 +2403,8 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
 
     Constructs a QMessageLogger to record \a category messages for \a file at \a line
     in \a function.
+
+    \sa QLoggingCategory
 */
 
 /*!
@@ -2423,6 +2429,8 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
 
     Constructs a QMessageLogContext with for file \a fileName at line
     \a lineNumber, in function \a functionName, and category \a categoryName.
+
+    \sa QLoggingCategory
 */
 
 /*!
@@ -2458,8 +2466,8 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
     To suppress the output at runtime, install your own message handler
     with qInstallMessageHandler().
 
-    \sa qInfo(), qWarning(), qCritical(), qFatal(), qInstallMessageHandler(),
-        {Debugging Techniques}
+    \sa qCDebug(), qInfo(), qWarning(), qCritical(), qFatal(),
+        qInstallMessageHandler(), {Debugging Techniques}
 */
 
 /*!
@@ -2496,8 +2504,8 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
     To suppress the output at runtime, install your own message handler
     using qInstallMessageHandler().
 
-    \sa qDebug(), qWarning(), qCritical(), qFatal(), qInstallMessageHandler(),
-        {Debugging Techniques}
+    \sa qCInfo(), qDebug(), qWarning(), qCritical(), qFatal(),
+        qInstallMessageHandler(), {Debugging Techniques}
 */
 
 /*!
@@ -2540,8 +2548,8 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
     on the first call; if it contains the value 10, it will exit on the 10th
     call. Any non-numeric value in the environment variable is equivalent to 1.
 
-    \sa qDebug(), qInfo(), qCritical(), qFatal(), qInstallMessageHandler(),
-        {Debugging Techniques}
+    \sa qCWarning(), qDebug(), qInfo(), qCritical(), qFatal(),
+        qInstallMessageHandler(), {Debugging Techniques}
 */
 
 /*!
@@ -2583,8 +2591,8 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
     on the first call; if it contains the value 10, it will exit on the 10th
     call. Any non-numeric value in the environment variable is equivalent to 1.
 
-    \sa qDebug(), qInfo(), qWarning(), qFatal(), qInstallMessageHandler(),
-        {Debugging Techniques}
+    \sa qCCritical(), qDebug(), qInfo(), qWarning(), qFatal(),
+        qInstallMessageHandler(), {Debugging Techniques}
 */
 
 /*!
@@ -2610,8 +2618,8 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
     To suppress the output at runtime, install your own message handler
     with qInstallMessageHandler().
 
-    \sa qDebug(), qInfo(), qWarning(), qCritical(), qInstallMessageHandler(),
-        {Debugging Techniques}
+    \sa qCFatal(), qDebug(), qInfo(), qWarning(), qCritical(),
+        qInstallMessageHandler(), {Debugging Techniques}
 */
 
 /*!
@@ -2635,7 +2643,7 @@ QMessageLogContext &QMessageLogContext::copyContextFrom(const QMessageLogContext
            A message generated by the qFatal() function.
     \omitvalue QtSystemMsg
 
-    \sa QtMessageHandler, qInstallMessageHandler()
+    \sa QtMessageHandler, qInstallMessageHandler(), QLoggingCategory
 */
 
 QT_END_NAMESPACE