From 70815d31fe6075d15a85be90c940d3f9d3b8d05c Mon Sep 17 00:00:00 2001
From: Rym Bouabid <rym.bouabid@qt.io>
Date: Mon, 11 Sep 2023 16:32:10 +0200
Subject: [PATCH] Revamp Semaphores example: Revisit the documentation

Change the title.

Remove the first \brief as there are two briefs in the document
so that the new title makes sense with the second brief in
"All Qt Examples" doc page.

Task-number: QTBUG-108859
Pick-to: 6.6 6.5
Change-Id: I8b0370c9a85179e172918231ae48a3c52845bf21
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
---
 examples/corelib/threads/doc/src/semaphores.qdoc | 9 ++++-----
 src/corelib/kernel/qcoreapplication.cpp          | 2 +-
 src/corelib/thread/qsemaphore.cpp                | 5 +++--
 src/corelib/thread/qthread.cpp                   | 3 ++-
 4 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/examples/corelib/threads/doc/src/semaphores.qdoc b/examples/corelib/threads/doc/src/semaphores.qdoc
index b8e1ab1b521..964225ffeed 100644
--- a/examples/corelib/threads/doc/src/semaphores.qdoc
+++ b/examples/corelib/threads/doc/src/semaphores.qdoc
@@ -3,13 +3,12 @@
 
 /*!
     \example threads/semaphores
-    \title Semaphores Example
-    \brief Demonstrates multi-thread programming using Qt.
+    \title Producer and Consumer using Semaphores
     \ingroup qtconcurrent-mtexamples
 
-    \brief The Semaphores example shows how to use QSemaphore to control
-    access to a circular buffer shared by a producer thread and a
-    consumer thread.
+    \brief The Producer and Consumer using Semaphores example shows how
+    to use QSemaphore to control access to a circular buffer shared
+    by a producer thread and a consumer thread.
 
     The producer writes data to the buffer until it reaches the end
     of the buffer, at which point it restarts from the beginning,
diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp
index 2844da771f1..ec4aad7b1d6 100644
--- a/src/corelib/kernel/qcoreapplication.cpp
+++ b/src/corelib/kernel/qcoreapplication.cpp
@@ -752,7 +752,7 @@ void QCoreApplicationPrivate::initLocale()
     to reset the locale that is used for number formatting to "C"-locale.
 
     \sa QGuiApplication, QAbstractEventDispatcher, QEventLoop,
-    {Semaphores Example}, {Wait Conditions Example}
+    {Producer and Consumer using Semaphores}, {Wait Conditions Example}
 */
 
 /*!
diff --git a/src/corelib/thread/qsemaphore.cpp b/src/corelib/thread/qsemaphore.cpp
index 2437c96595b..b11a7051b64 100644
--- a/src/corelib/thread/qsemaphore.cpp
+++ b/src/corelib/thread/qsemaphore.cpp
@@ -50,7 +50,7 @@ using namespace QtFutex;
 
     A typical application of semaphores is for controlling access to
     a circular buffer shared by a producer thread and a consumer
-    thread. The \l{Semaphores Example} shows how
+    thread. The \l{Producer and Consumer using Semaphores} example shows how
     to use QSemaphore to solve that problem.
 
     A non-computing example of a semaphore would be dining at a
@@ -63,7 +63,8 @@ using namespace QtFutex;
     seated (taking the available seats to 5, making the party of 10
     people wait longer).
 
-    \sa QSemaphoreReleaser, QMutex, QWaitCondition, QThread, {Semaphores Example}
+    \sa QSemaphoreReleaser, QMutex, QWaitCondition, QThread,
+        {Producer and Consumer using Semaphores}
 */
 
 /*
diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp
index ab5893f7ab0..bade2e529a2 100644
--- a/src/corelib/thread/qthread.cpp
+++ b/src/corelib/thread/qthread.cpp
@@ -288,7 +288,8 @@ QThreadPrivate::~QThreadPrivate()
     Note that this is currently not available with release builds on Windows.
 
     \sa {Thread Support in Qt}, QThreadStorage, {Synchronizing Threads},
-        Mandelbrot, {Semaphores Example}, {Wait Conditions Example}
+        Mandelbrot, {Producer and Consumer using Semaphores},
+        {Wait Conditions Example}
 */
 
 /*!