Doc: Better integrate Qt Spatial Audio into multimedia documentation

Instead of just a single mention of the Spatial Audio module, list its
types on the top-level module pages, and link to it from the overviews.

List the spatialaudio example(s) as part of the main example group
for multimedia.

Mark Qt Spatial Audio as a Tech. Preview.

Pick-to: 6.4
Change-Id: I9d5bf0482aadc8516c9b79ab9acda5fbd898f1cb
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>

23 files changed, 61 insertions, 28 deletions

diff --git a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
index df4f20d2d..805f293d4 100644
--- a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
+++ b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
@@ -5,6 +5,7 @@
     \example audiodevices
     \title Audio Devices Example
     \ingroup multimedia_examples
+    \ingroup audio_examples
     \brief Testing the available audio devices and their configuration.
     \meta {tag} {widgets}
 
diff --git a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
index f6fe14ae7..a22449d16 100644
--- a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
+++ b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
@@ -5,6 +5,7 @@
     \example audiooutput
     \title Audio Output Example
     \ingroup multimedia_examples
+    \ingroup audio_examples
     \brief Enabling audio playback using the QAudioSink class.
     \meta {tag} {widgets}
 
diff --git a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
index a280c2b73..9a84536cb 100644
--- a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
+++ b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
@@ -5,6 +5,7 @@
     \example audiorecorder
     \title Audio Recorder Example
     \ingroup multimedia_examples
+    \ingroup audio_examples
     \brief Discovering the available devices and supported codecs.
     \meta {tag} {widgets}
 
diff --git a/examples/multimedia/audiosource/doc/src/audiosource.qdoc b/examples/multimedia/audiosource/doc/src/audiosource.qdoc
index 8c8ee6958..e469a5291 100644
--- a/examples/multimedia/audiosource/doc/src/audiosource.qdoc
+++ b/examples/multimedia/audiosource/doc/src/audiosource.qdoc
@@ -5,6 +5,7 @@
     \example audiosource
     \title Audio Source Example
     \ingroup multimedia_examples
+    \ingroup audio_examples
     \brief Recording audio using the QAudioSource class.
     \meta {tag} {widgets}
 
diff --git a/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc b/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc
index 76793c7e2..ff273e0aa 100644
--- a/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc
+++ b/examples/spatialaudio/audiopanning/doc/src/audiopanning.qdoc
@@ -5,6 +5,7 @@
 \example audiopanning
 \title Spatial Audio Panning Example
 \ingroup spatialaudio_examples
+\ingroup audio_examples
 \meta {tag} {widgets}
 \brief Shows some of the capabilities of the spatial audio engine in Qt.
 
diff --git a/src/multimedia/doc/src/audiooverview.qdoc b/src/multimedia/doc/src/audiooverview.qdoc
index 3fb26695b..af5d000d8 100644
--- a/src/multimedia/doc/src/audiooverview.qdoc
+++ b/src/multimedia/doc/src/audiooverview.qdoc
@@ -120,13 +120,10 @@ Here's an example of decoding a local file:
 
     \snippet multimedia-snippets/audio.cpp Local audio decoding
 
-\section1 Examples
+\section2 Spatial Audio
 
-There are both C++ and QML examples available.
-
-\section2 C++ Examples
-
-\annotatedlist audio_examples
+The \l {Qt Spatial Audio} module provides an API for implementation sound
+fields in 3D space.
 
 \section1 Reference Documentation
 
@@ -138,5 +135,8 @@ There are both C++ and QML examples available.
 
 \annotatedlist multimedia_audio_qml
 
+\section2 Examples
+
+\annotatedlist audio_examples
 */
 
diff --git a/src/multimedia/doc/src/multimedia-overview.qdoc b/src/multimedia/doc/src/multimedia-overview.qdoc
index ca41a948c..6345c2b0a 100644
--- a/src/multimedia/doc/src/multimedia-overview.qdoc
+++ b/src/multimedia/doc/src/multimedia-overview.qdoc
@@ -20,6 +20,7 @@ Here are some things you can do with the Qt Multimedia APIs:
 \list
 \li Access raw audio devices for input and output.
 \li Play low latency sound effects.
+\li Play 3D spatial audio.
 \li Play media files in playlists (such as compressed audio or video files).
 \li Record audio and compress it.
 \li Use a camera, including viewfinder, image capture, and movie recording
@@ -36,11 +37,9 @@ can also take a look at some \l{Multimedia Recipes}{recipes}.
 \li \l {Audio Overview}
 \li \l {Video Overview}
 \li \l {Camera Overview}
+\li \l {Spatial Audio Overview} (Technology Preview)
 \endlist
 
-If you're interested in adding spatial audio experiences to your application, have
-a look at the \l {Qt Spatial Audio} module.
-
 \section1 Multimedia Recipes
 
 For some quick recipes, see this table:
@@ -57,6 +56,11 @@ For some quick recipes, see this table:
         \li \l{SoundEffect}
         \li QSoundEffect
     \row
+        \li Playing 3D sound
+        \li \l{Spatial Audio Panning Example}{audiopanning}
+        \li SpatialSound, AudioEngine
+        \li QSpatialSound, QAudioEngine
+    \row
         \li Playing encoded audio (MP3, AAC etc)
         \li \l{Media Player Example}{player}
         \li \l{MediaPlayer}
@@ -123,14 +127,8 @@ you might need to change when porting code to Qt 6.
 
 \section1 Reference Documentation
 
-\section2 QML Types
-The QML types are accessed by using:
-\code
-import QtMultimedia
-\endcode
-
-\section2 Multimedia Classes
-
-\annotatedlist multimedia
-
+\list
+    \li {Qt Multimedia C++ Classes}{C++ Classes}
+    \li {Qt Multimedia QML types}{QML Types}
+\endlist
 */
diff --git a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc
index e5958912b..b0c4ea732 100644
--- a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc
@@ -39,4 +39,7 @@
 
     \section2 Qt Multimedia Widgets Module
     \generatelist {classesbymodule QtMultimediaWidgets}
+
+    \section2 Qt Spatial Audio Module
+    \generatelist {classesbymodule QtSpatialAudio}
 */
diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index 7099cbcc5..424e60362 100644
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -19,10 +19,14 @@
     \table
      \row
       \li \l{Multimedia Overview}{Qt Multimedia}
-      \li Provides API for multimedia-specific use cases.
+      \li Provides an API for multimedia-specific use cases.
      \row
       \li \l{Qt Multimedia Widgets}
-      \li Provides the widget-based multimedia API.
+      \li Provides a widget-based multimedia API.
+    \row
+      \li \l{Qt Spatial Audio}
+      \li (Technology Preview)
+          Provides an API for implementing sound fields in 3D space.
     \endtable
 
     \section1 Getting started
@@ -51,6 +55,7 @@
       \li \l{Changes to Qt Multimedia}{Changes in Qt 6}
       \li \l{Multimedia Overview}
       \li \l{Audio Overview}
+      \li \l{Spatial Audio Overview} (Technology Preview)
       \li \l{Video Overview}
       \li \l{Camera Overview}
       \li \l{Supported Media Formats}
diff --git a/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc b/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc
index 8a68d5a05..077bb99d8 100644
--- a/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc
@@ -3,6 +3,7 @@
 
 /*!
 \qmlmodule QtMultimedia
+\noautolist
 \title Qt Multimedia QML Types
 \ingroup qmlmodules
 \brief Provides QML types for multimedia support.
@@ -20,11 +21,20 @@ The QML types for \l{Qt Multimedia} support the basic use cases such as:
 Qt Multimedia QML types can be imported into your application using the
 following import statement in your .qml file:
 
-\qml \QtMinorVersion
+\qml
 import QtMultimedia
 \endqml
 
 \generatelist qmltypesbymodule QtMultimedia
 
-\noautolist
+\section2 Qt Spatial Audio Module
+
+Qt Spatial Audio QML types can be imported into your application using the
+following import statement in your .qml file:
+
+\qml
+import QtQuick3D.SpatialAudio
+\endqml
+
+\generatelist qmltypesbymodule QtQuick3D.SpatialAudio
 */
diff --git a/src/spatialaudio/doc/qtspatialaudio.qdocconf b/src/spatialaudio/doc/qtspatialaudio.qdocconf
index 6dd1f13f1..d3e582eac 100644
--- a/src/spatialaudio/doc/qtspatialaudio.qdocconf
+++ b/src/spatialaudio/doc/qtspatialaudio.qdocconf
@@ -3,6 +3,7 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
 project                 = QtSpatialAudio
 description             = Qt Spatial Audio Documentation
 version                 = $QT_VERSION
+buildversion            = "Technology Preview"
 
 moduleheader            = QtSpatialAudio
 includepaths           += .
diff --git a/src/spatialaudio/doc/src/qtspatialaudio-examples.qdoc b/src/spatialaudio/doc/src/qtspatialaudio-examples.qdoc
index e6a01f3b2..2e4138041 100644
--- a/src/spatialaudio/doc/src/qtspatialaudio-examples.qdoc
+++ b/src/spatialaudio/doc/src/qtspatialaudio-examples.qdoc
@@ -4,6 +4,7 @@
 /*!
     \group spatialaudio_examples
     \ingroup all-examples
+    \ingroup multimedia_examples
     \title Qt Spatial Audio Examples
     \brief Demonstrates the spatial audio functionality provided by Qt.
 
diff --git a/src/spatialaudio/doc/src/qtspatialaudio-qml-types.qdoc b/src/spatialaudio/doc/src/qtspatialaudio-qml-types.qdoc
index 3dc52f4bd..fbd1853d3 100644
--- a/src/spatialaudio/doc/src/qtspatialaudio-qml-types.qdoc
+++ b/src/spatialaudio/doc/src/qtspatialaudio-qml-types.qdoc
@@ -16,11 +16,11 @@ Qt Spatial Audio QML types are designed to be used together with \l{Qt Quick 3D}
 can be imported into your application using the following import statement in your
 .qml file:
 
-\qml \QtMinorVersion
+\qml
 import QtQuick3D.SpatialAudio
 \endqml
 
-\generatelist qmltypesbymodule QtSpatialAudio
+\generatelist qmltypesbymodule QtQuick3D.SpatialAudio
 
 \noautolist
 */
diff --git a/src/spatialaudio/qambientsound.cpp b/src/spatialaudio/qambientsound.cpp
index 5cc91df66..03846638f 100644
--- a/src/spatialaudio/qambientsound.cpp
+++ b/src/spatialaudio/qambientsound.cpp
@@ -14,6 +14,7 @@ QT_BEGIN_NAMESPACE
     \class QAmbientSound
     \inmodule QtSpatialAudio
     \ingroup spatialaudio
+    \ingroup multimedia_audio
 
     \brief A stereo overlay sound.
 
diff --git a/src/spatialaudio/qaudioengine.cpp b/src/spatialaudio/qaudioengine.cpp
index 1b906ba91..df6112adb 100644
--- a/src/spatialaudio/qaudioengine.cpp
+++ b/src/spatialaudio/qaudioengine.cpp
@@ -283,6 +283,7 @@ QVector3D QAudioEnginePrivate::listenerPosition() const
     \class QAudioEngine
     \inmodule QtSpatialAudio
     \ingroup spatialaudio
+    \ingroup multimedia_audio
 
     \brief QAudioEngine manages a three dimensional sound field.
 
diff --git a/src/spatialaudio/qaudiolistener.cpp b/src/spatialaudio/qaudiolistener.cpp
index 175686735..338826d58 100644
--- a/src/spatialaudio/qaudiolistener.cpp
+++ b/src/spatialaudio/qaudiolistener.cpp
@@ -22,6 +22,7 @@ public:
     \class QAudioListener
     \inmodule QtSpatialAudio
     \ingroup spatialaudio
+    \ingroup multimedia_audio
 
     \brief Defines the position and orientation of the person listening to a sound field
     defined by QAudioEngine.
diff --git a/src/spatialaudio/qaudioroom.cpp b/src/spatialaudio/qaudioroom.cpp
index 13b1e3db3..b111936fa 100644
--- a/src/spatialaudio/qaudioroom.cpp
+++ b/src/spatialaudio/qaudioroom.cpp
@@ -102,6 +102,7 @@ void QAudioRoomPrivate::update()
     \class QAudioRoom
     \inmodule QtSpatialAudio
     \ingroup spatialaudio
+    \ingroup multimedia_audio
 
     Defines a room for the spatial audio engine.
 
diff --git a/src/spatialaudio/qspatialsound.cpp b/src/spatialaudio/qspatialsound.cpp
index 3ca72122e..ed6242d75 100644
--- a/src/spatialaudio/qspatialsound.cpp
+++ b/src/spatialaudio/qspatialsound.cpp
@@ -16,6 +16,7 @@ QT_BEGIN_NAMESPACE
     \class QSpatialSound
     \inmodule QtSpatialAudio
     \ingroup spatialaudio
+    \ingroup multimedia_audio
 
     \brief A sound object in 3D space.
 
diff --git a/src/spatialaudioquick3d/qquick3dambientsound.cpp b/src/spatialaudioquick3d/qquick3dambientsound.cpp
index 165052e98..3b8ca4918 100644
--- a/src/spatialaudioquick3d/qquick3dambientsound.cpp
+++ b/src/spatialaudioquick3d/qquick3dambientsound.cpp
@@ -14,6 +14,7 @@ QT_BEGIN_NAMESPACE
     \qmltype AmbientSound
     \inqmlmodule QtQuick3D.SpatialAudio
     \ingroup quick3d_spatialaudio
+    \ingroup multimedia_audio_qml
 
     \brief A stereo overlay sound.
 
@@ -38,7 +39,7 @@ QQuick3DAmbientSound::~QQuick3DAmbientSound()
 }
 
 /*!
-    \qmlproperty url QAmbientSound::source
+    \qmlproperty url AmbientSound::source
 
     The source file for the sound to be played.
  */
@@ -61,7 +62,7 @@ void QQuick3DAmbientSound::setSource(QUrl source)
 }
 
 /*!
-    \qmlproperty float QAmbientSound::volume
+    \qmlproperty float AmbientSound::volume
 
     Defines an overall volume for this sound source.
  */
@@ -76,7 +77,7 @@ float QQuick3DAmbientSound::volume() const
 }
 
 /*!
-   \qmlproperty int QAmbientSound::loops
+   \qmlproperty int AmbientSound::loops
 
     Determines how often the sound is played before the player stops.
     Set to QAmbienSound::Infinite to loop the current sound forever.
diff --git a/src/spatialaudioquick3d/qquick3daudioengine.cpp b/src/spatialaudioquick3d/qquick3daudioengine.cpp
index 55e998730..1288effb3 100644
--- a/src/spatialaudioquick3d/qquick3daudioengine.cpp
+++ b/src/spatialaudioquick3d/qquick3daudioengine.cpp
@@ -11,6 +11,7 @@ static QAudioEngine *globalEngine = nullptr;
     \qmltype AudioEngine
     \inqmlmodule QtQuick3D.SpatialAudio
     \ingroup quick3d_spatialaudio
+    \ingroup multimedia_audio_qml
 
     \brief AudioEngine manages sound objects inside a 3D scene.
 
diff --git a/src/spatialaudioquick3d/qquick3daudiolistener.cpp b/src/spatialaudioquick3d/qquick3daudiolistener.cpp
index 2ebdacf89..b8445a799 100644
--- a/src/spatialaudioquick3d/qquick3daudiolistener.cpp
+++ b/src/spatialaudioquick3d/qquick3daudiolistener.cpp
@@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
     \qmltype AudioListener
     \inqmlmodule QtQuick3D.SpatialAudio
     \ingroup quick3d_spatialaudio
+    \ingroup multimedia_audio_qml
 
     \brief defines the position and orientation of the person listening to a sound field
     defined by a AudioEngine.
diff --git a/src/spatialaudioquick3d/qquick3daudioroom.cpp b/src/spatialaudioquick3d/qquick3daudioroom.cpp
index d3b8912d0..b79a6f609 100644
--- a/src/spatialaudioquick3d/qquick3daudioroom.cpp
+++ b/src/spatialaudioquick3d/qquick3daudioroom.cpp
@@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
     \qmltype AudioRoom
     \inqmlmodule QtQuick3D.SpatialAudio
     \ingroup quick3d_spatialaudio
+    \ingroup multimedia_audio_qml
 
     Defines a room for the spatial audio engine.
 
diff --git a/src/spatialaudioquick3d/qquick3dspatialsound.cpp b/src/spatialaudioquick3d/qquick3dspatialsound.cpp
index 79926d93a..04c935c56 100644
--- a/src/spatialaudioquick3d/qquick3dspatialsound.cpp
+++ b/src/spatialaudioquick3d/qquick3dspatialsound.cpp
@@ -14,6 +14,7 @@ QT_BEGIN_NAMESPACE
     \qmltype SpatialSound
     \inqmlmodule QtQuick3D.SpatialAudio
     \ingroup quick3d_spatialaudio
+    \ingroup multimedia_audio_qml
 
     \brief A sound object in 3D space.