Remove antiquated \since lines in docs.
They aren't useful in the case of QtMultimedia{Kit}
Change-Id: If1b0b6625763c85907fb05beb9c440046472ddef
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
committed by
Qt by Nokia
parent
b228ff95d7
commit
a6268601c9
@@ -55,7 +55,6 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\inmodule QtMultimedia
|
||||
\ingroup multimedia
|
||||
\since 1.0
|
||||
|
||||
You can construct an audio input with the system's
|
||||
\l{QAudioDeviceInfo::defaultInputDevice()}{default audio input
|
||||
@@ -117,7 +116,6 @@ QT_BEGIN_NAMESPACE
|
||||
Construct a new audio input and attach it to \a parent.
|
||||
The default audio input device is used with the output
|
||||
\a format parameters.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QAudioInput::QAudioInput(const QAudioFormat &format, QObject *parent):
|
||||
@@ -132,7 +130,6 @@ QAudioInput::QAudioInput(const QAudioFormat &format, QObject *parent):
|
||||
Construct a new audio input and attach it to \a parent.
|
||||
The device referenced by \a audioDevice is used with the input
|
||||
\a format parameters.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QAudioInput::QAudioInput(const QAudioDeviceInfo &audioDevice, const QAudioFormat &format, QObject *parent):
|
||||
@@ -164,7 +161,6 @@ QAudioInput::~QAudioInput()
|
||||
If a problem occurs during this process the error() is set to QAudio::OpenError,
|
||||
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
|
||||
|
||||
\since 1.0
|
||||
\sa QIODevice
|
||||
*/
|
||||
|
||||
@@ -185,7 +181,6 @@ void QAudioInput::start(QIODevice* device)
|
||||
If a problem occurs during this process the error() is set to QAudio::OpenError,
|
||||
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
|
||||
|
||||
\since 1.0
|
||||
\sa QIODevice
|
||||
*/
|
||||
|
||||
@@ -196,7 +191,6 @@ QIODevice* QAudioInput::start()
|
||||
|
||||
/*!
|
||||
Returns the QAudioFormat being used.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QAudioFormat QAudioInput::format() const
|
||||
@@ -209,7 +203,6 @@ QAudioFormat QAudioInput::format() const
|
||||
|
||||
Sets error() to QAudio::NoError, state() to QAudio::StoppedState and
|
||||
emit stateChanged() signal.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QAudioInput::stop()
|
||||
@@ -219,7 +212,6 @@ void QAudioInput::stop()
|
||||
|
||||
/*!
|
||||
Drops all audio data in the buffers, resets buffers to zero.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QAudioInput::reset()
|
||||
@@ -232,7 +224,6 @@ void QAudioInput::reset()
|
||||
|
||||
Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
|
||||
emit stateChanged() signal.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QAudioInput::suspend()
|
||||
@@ -247,7 +238,6 @@ void QAudioInput::suspend()
|
||||
Sets state() to QAudio::ActiveState if you previously called start(QIODevice*).
|
||||
Sets state() to QAudio::IdleState if you previously called start().
|
||||
emits stateChanged() signal.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QAudioInput::resume()
|
||||
@@ -263,7 +253,6 @@ void QAudioInput::resume()
|
||||
set is the actual buffer size used, calling bufferSize() anytime after start()
|
||||
will return the actual buffer size being used.
|
||||
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QAudioInput::setBufferSize(int value)
|
||||
@@ -279,7 +268,6 @@ void QAudioInput::setBufferSize(int value)
|
||||
If called after start(), returns the actual buffer size being used. This may not be what was set previously
|
||||
by setBufferSize().
|
||||
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
int QAudioInput::bufferSize() const
|
||||
@@ -292,7 +280,6 @@ int QAudioInput::bufferSize() const
|
||||
|
||||
NOTE: returned value is only valid while in QAudio::ActiveState or QAudio::IdleState
|
||||
state, otherwise returns zero.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
int QAudioInput::bytesReady() const
|
||||
@@ -308,7 +295,6 @@ int QAudioInput::bytesReady() const
|
||||
Returns the period size in bytes.
|
||||
|
||||
Note: This is the recommended read size in bytes.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
int QAudioInput::periodSize() const
|
||||
@@ -323,7 +309,6 @@ int QAudioInput::periodSize() const
|
||||
The minimum resolution of the timer is platform specific and values
|
||||
should be checked with notifyInterval() to confirm actual value
|
||||
being used.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QAudioInput::setNotifyInterval(int ms)
|
||||
@@ -333,7 +318,6 @@ void QAudioInput::setNotifyInterval(int ms)
|
||||
|
||||
/*!
|
||||
Returns the notify interval in milliseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
int QAudioInput::notifyInterval() const
|
||||
@@ -344,7 +328,6 @@ int QAudioInput::notifyInterval() const
|
||||
/*!
|
||||
Returns the amount of audio data processed since start()
|
||||
was called in microseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
qint64 QAudioInput::processedUSecs() const
|
||||
@@ -355,7 +338,6 @@ qint64 QAudioInput::processedUSecs() const
|
||||
/*!
|
||||
Returns the microseconds since start() was called, including time in Idle and
|
||||
Suspend states.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
qint64 QAudioInput::elapsedUSecs() const
|
||||
@@ -365,7 +347,6 @@ qint64 QAudioInput::elapsedUSecs() const
|
||||
|
||||
/*!
|
||||
Returns the error state.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QAudio::Error QAudioInput::error() const
|
||||
@@ -375,7 +356,6 @@ QAudio::Error QAudioInput::error() const
|
||||
|
||||
/*!
|
||||
Returns the state of audio processing.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QAudio::State QAudioInput::state() const
|
||||
@@ -386,14 +366,12 @@ QAudio::State QAudioInput::state() const
|
||||
/*!
|
||||
\fn QAudioInput::stateChanged(QAudio::State state)
|
||||
This signal is emitted when the device \a state has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAudioInput::notify()
|
||||
This signal is emitted when x ms of audio data has been processed
|
||||
the interval set by setNotifyInterval(x).
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QT_END_NAMESPACE
|
||||
|
||||
Reference in New Issue
Block a user