summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2021-08-20 10:51:16 +0300
committerNicholas Bennett <nicholas.bennett@qt.io>2021-08-20 13:52:09 +0300
commit7ffdf8676d65efd29feec621d8526c9d1f205712 (patch)
tree2717fb8d194d9298b0a134749fb285dc58f2bd8e
parent96cd25edcdbf40e67b3265fd9ab8eea611983803 (diff)
Doc: Fix small spelling mistakes, incorrect QAudioOutput references
QAudioInput referred to output in its class description, fixed this. Reflowed lines to 80 characters were needed. Fixed spelling, grammar, hyphenation noticed in other areas. Added qdoc commands for notes and variable formatting. Task-number: QTBUG-95115 Pick-to: 6.2 Change-Id: I0e12c6d964c3418427c42cc68112099ee59a91c3 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--src/multimedia/audio/qaudioformat.cpp17
-rw-r--r--src/multimedia/audio/qaudioinput.cpp36
-rw-r--r--src/multimedia/audio/qaudiooutput.cpp39
3 files changed, 51 insertions, 41 deletions
diff --git a/src/multimedia/audio/qaudioformat.cpp b/src/multimedia/audio/qaudioformat.cpp
index d2623a802..5eee80cda 100644
--- a/src/multimedia/audio/qaudioformat.cpp
+++ b/src/multimedia/audio/qaudioformat.cpp
@@ -50,13 +50,12 @@ QT_BEGIN_NAMESPACE
\ingroup multimedia
\ingroup multimedia_audio
- An audio format specifies how data in a raw audio stream is arranged,
- i.e, how the stream is to be interpreted.
+ An audio format specifies how data in a raw audio stream is arranged. For
+ example, how the stream is to be interpreted.
QAudioFormat contains parameters that specify how the audio sample data
is arranged. These are the frequency, the number of channels, and the
- sameple format. The following table describes
- these in more detail.
+ sample format. The following table describes these in more detail.
\table
\header
@@ -95,7 +94,7 @@ QT_BEGIN_NAMESPACE
/*!
\fn QAudioFormat::QAudioFormat()
- Construct a new audio format.
+ Constructs a new audio format.
Values are initialized as follows:
\list
@@ -126,13 +125,13 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QAudioFormat::isValid() const
- Returns true if all of the parameters are valid.
+ Returns \c true if all of the parameters are valid.
*/
/*!
\fn void QAudioFormat::setSampleRate(int samplerate)
- Sets the sample rate to \a samplerate Hertz.
+ Sets the sample rate to \a samplerate in Hertz.
*/
/*!
@@ -151,7 +150,7 @@ QT_BEGIN_NAMESPACE
\value FrontLeft
\value FrontRight
\value FrontCenter
- \value LFE Low Frequence Effect channel (Subwoofer)
+ \value LFE Low Frequency Effect channel (Subwoofer)
\value BackLeft
\value BackRight
\value FrontLeftOfCenter
@@ -401,7 +400,7 @@ float QAudioFormat::normalizedSampleValue(const void *sample) const
\value Unknown Not Set
\value UInt8 Samples are unsigned 8 bit signed integers
\value Int16 Samples are 16 bit signed integers
- \value Int32 Samples are 32 bit signed intergers
+ \value Int32 Samples are 32 bit signed integers
\value Float Samples are floats
\omitvalue NSampleFormats
*/
diff --git a/src/multimedia/audio/qaudioinput.cpp b/src/multimedia/audio/qaudioinput.cpp
index e257e8f3f..431e2a871 100644
--- a/src/multimedia/audio/qaudioinput.cpp
+++ b/src/multimedia/audio/qaudioinput.cpp
@@ -45,45 +45,49 @@
/*!
\class QAudioInput
- \brief The QAudioOutput class represents an input channel for audio.
+ \brief Represents an input channel for audio.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
- QAudioOutput represents an output channel that can be used together QMediaCaptureSession.
- It allows selecting the physical input device to be used, muting the channel
- or changing its volume.
+ This class represents an input channel that can be used together with
+ QMediaCaptureSession. It enables the selection of the physical input device
+ to be used, muting the channel, and changing the channel's volume.
*/
/*!
\property QAudioInput::volume
- \brief the current volume.
+ \brief The current volume.
- The volume is scaled linearly, ranging from \c 0 (silence) to \c 1 (full volume).
- Values outside this range will be clamped.
+ The volume is scaled linearly, ranging from \c 0 (silence) to \c 1
+ (full volume).
+ \note values outside this range will be clamped.
By default the volume is \c 1.
- UI volume controls should usually be scaled nonlinearly. For example, using a logarithmic scale
- will produce linear changes in perceived loudness, which is what a user would normally expect
- from a volume control. See QAudio::convertVolume() for more details.
+ UI volume controls should usually be scaled non-linearly. For example,
+ using a logarithmic scale will produce linear changes in perceived loudness,
+ which is what a user would normally expect from a volume control.
+ \sa QAudio::convertVolume()
*/
/*!
\property QAudioInput::muted
- \brief the muted state of the current media.
+ \brief The muted state of the current media.
- The value will be true if the input is muted; otherwise false.
+ The value will be \c true if the input is muted; otherwise \c false.
*/
/*!
\property QAudioInput::device
- \brief the audio device connected to this input.
+ \brief The audio device connected to this input.
- The device property represents the audio device connected to this input. A default constructed
- QAudioInput object will be connected to the systems default audio input at construction time.
+ The device property represents the audio device connected to this input. A
+ default constructed QAudioInput object will be connected to the system's
+ default audio input at construction time.
- This property can be used to select any other output device listed by QMediaDevices::audioInputs().
+ This property can be used to select any other input device listed by
+ QMediaDevices::audioInputs().
*/
QAudioInput::QAudioInput(QObject *parent)
diff --git a/src/multimedia/audio/qaudiooutput.cpp b/src/multimedia/audio/qaudiooutput.cpp
index ba07022ab..5f49e8f26 100644
--- a/src/multimedia/audio/qaudiooutput.cpp
+++ b/src/multimedia/audio/qaudiooutput.cpp
@@ -45,46 +45,53 @@
/*!
\class QAudioOutput
- \brief The QAudioOutput class represents an output channel for audio.
+ \brief Represents an output channel for audio.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
\since 6.0
- QAudioOutput represents an output channel that can be used together with QMediaPlayer or
- QMediaCaptureSession. It allows selecting the physical output device to be used, muting the channel
- or changing its volume.
+ This class represents an output channel that can be used together with
+ QMediaPlayer or QMediaCaptureSession. It enables the selection of the
+ physical output device to be used, muting the channel, and changing the
+ channel's volume.
*/
/*!
\property QAudioOutput::volume
- \brief the current volume.
+ \brief The current volume.
- The volume is scaled linearly, ranging from \c 0 (silence) to \c 1 (full volume).
- Values outside this range will be clamped.
+ The volume is scaled linearly, ranging from \c 0 (silence) to \c 1
+ (full volume).
+ \note values outside this range will be clamped.
By default the volume is \c 1.
- UI volume controls should usually be scaled nonlinearly. For example, using a logarithmic scale
- will produce linear changes in perceived loudness, which is what a user would normally expect
- from a volume control. See QAudio::convertVolume() for more details.
+ UI volume controls should usually be scaled non-linearly. For example,
+ using a logarithmic scale will produce linear changes in perceived loudness,
+ which is what a user would normally expect from a volume control.
+
+ \sa QAudio::convertVolume()
*/
/*!
\property QAudioOutput::muted
- \brief the muted state of the current media.
+ \brief The muted state of the current media.
- The value will be true if the output is muted; otherwise false.
+ The value will be \c true if the output is muted; otherwise \c{false}.
*/
/*!
\property QAudioOutput::device
- \brief the audio device connected to this output.
+ \brief The audio device connected to this output.
- The device property represents the audio device connected to this output. A default constructed
- QAudioOutput object will be connected to the systems default audio output at construction time.
+ The device property represents the audio device connected to this output.
+ A default constructed
+ QAudioOutput object will be connected to the systems default audio output at
+ construction time.
- This property can be used to select any other output device listed by QMediaDevices::audioOutputs().
+ This property can be used to select any other output device listed by
+ QMediaDevices::audioOutputs().
*/
QAudioOutput::QAudioOutput(QObject *parent)