Doc: Fix documentation warnings

Add a custom module header, used only for documentation builds, that
pulls in also the QtMultimediaWidgets module.

Several documentation fixes to clean up warnings from clang.

Task-number: QTBUG-67790
Change-Id: I6c1013798a648250c8555eb92684ec3b33ff7531
Reviewed-by: Martin Smith <martin.smith@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

6 files changed, 13 insertions, 19 deletions

diff --git a/src/multimedia/audio/qaudioinput.h b/src/multimedia/audio/qaudioinput.h
index db482a145..b17fd4d79 100644
--- a/src/multimedia/audio/qaudioinput.h
+++ b/src/multimedia/audio/qaudioinput.h
@@ -95,7 +95,7 @@ public:
     QAudio::State state() const;
 
 Q_SIGNALS:
-    void stateChanged(QAudio::State);
+    void stateChanged(QAudio::State state);
     void notify();
 
 private:
diff --git a/src/multimedia/audio/qaudiooutput.h b/src/multimedia/audio/qaudiooutput.h
index 1c037cd2b..5f466d8e1 100644
--- a/src/multimedia/audio/qaudiooutput.h
+++ b/src/multimedia/audio/qaudiooutput.h
@@ -98,7 +98,7 @@ public:
     void setCategory(const QString &category);
 
 Q_SIGNALS:
-    void stateChanged(QAudio::State);
+    void stateChanged(QAudio::State state);
     void notify();
 
 private:
diff --git a/src/multimedia/audio/qaudioprobe.h b/src/multimedia/audio/qaudioprobe.h
index a3fc4598d..e0d5619d2 100644
--- a/src/multimedia/audio/qaudioprobe.h
+++ b/src/multimedia/audio/qaudioprobe.h
@@ -62,7 +62,7 @@ public:
     bool isActive() const;
 
 Q_SIGNALS:
-    void audioBufferProbed(const QAudioBuffer &audioBuffer);
+    void audioBufferProbed(const QAudioBuffer &buffer);
     void flush();
 
 private:
diff --git a/src/multimedia/audio/qaudiosystem.h b/src/multimedia/audio/qaudiosystem.h
index dabf8df0b..c326460fe 100644
--- a/src/multimedia/audio/qaudiosystem.h
+++ b/src/multimedia/audio/qaudiosystem.h
@@ -51,9 +51,6 @@ QT_BEGIN_NAMESPACE
 
 class QIODevice;
 
-// Required for QDoc workaround
-class QString;
-
 class Q_MULTIMEDIA_EXPORT QAbstractAudioDeviceInfo : public QObject
 {
     Q_OBJECT
@@ -99,8 +96,8 @@ public:
     virtual void setCategory(const QString &) { }
 
 Q_SIGNALS:
-    void errorChanged(QAudio::Error);
-    void stateChanged(QAudio::State);
+    void errorChanged(QAudio::Error error);
+    void stateChanged(QAudio::State state);
     void notify();
 };
 
@@ -131,8 +128,8 @@ public:
     virtual qreal volume() const = 0;
 
 Q_SIGNALS:
-    void errorChanged(QAudio::Error);
-    void stateChanged(QAudio::State);
+    void errorChanged(QAudio::Error error);
+    void stateChanged(QAudio::State state);
     void notify();
 };
 
diff --git a/src/multimedia/audio/qaudiosystemplugin.cpp b/src/multimedia/audio/qaudiosystemplugin.cpp
index 6a255cf11..cb5628477 100644
--- a/src/multimedia/audio/qaudiosystemplugin.cpp
+++ b/src/multimedia/audio/qaudiosystemplugin.cpp
@@ -90,7 +90,9 @@ QAudioSystemPluginExtension::~QAudioSystemPluginExtension()
 */
 
 /*!
-    Construct a new audio plugin with \a parent.
+    \fn QAudioSystemPlugin::QAudioSystemPlugin(QObject* parent)
+
+    Constructs a new audio plugin with \a parent.
     This is invoked automatically by the Q_PLUGIN_METADATA() macro.
 */
 
@@ -99,9 +101,10 @@ QAudioSystemPlugin::QAudioSystemPlugin(QObject* parent) :
 {}
 
 /*!
-   Destroy the audio plugin
+    \fn QAudioSystemPlugin::~QAudioSystemPlugin()
 
-   You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.
+    Destroys the audio plugin.
+    You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.
 */
 
 QAudioSystemPlugin::~QAudioSystemPlugin()
diff --git a/src/multimedia/audio/qaudiosystemplugin.h b/src/multimedia/audio/qaudiosystemplugin.h
index 3539201a2..18079e9d9 100644
--- a/src/multimedia/audio/qaudiosystemplugin.h
+++ b/src/multimedia/audio/qaudiosystemplugin.h
@@ -53,9 +53,6 @@
 
 QT_BEGIN_NAMESPACE
 
-// Required for QDoc workaround
-class QString;
-
 struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface
 {
     virtual QList<QByteArray> availableDevices(QAudio::Mode) const = 0;
@@ -69,9 +66,6 @@ struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface
     "org.qt-project.qt.audiosystemfactory/5.0"
 Q_DECLARE_INTERFACE(QAudioSystemFactoryInterface, QAudioSystemFactoryInterface_iid)
 
-// Required for QDoc workaround
-class QString;
-
 class Q_MULTIMEDIA_EXPORT QAudioSystemPlugin : public QObject, public QAudioSystemFactoryInterface
 {
     Q_OBJECT