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
@@ -73,7 +73,6 @@ namespace
|
||||
|
||||
\inmodule QtMultimedia
|
||||
\ingroup multimedia
|
||||
\since 1.0
|
||||
|
||||
You can control the systems analog radio device using this interface, for example:
|
||||
|
||||
@@ -104,7 +103,6 @@ public:
|
||||
Constructs a radio tuner based on a media service allocated by a media service \a provider.
|
||||
|
||||
The \a parent is passed to QMediaObject.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QRadioTuner::QRadioTuner(QObject *parent, QMediaServiceProvider* provider):
|
||||
@@ -147,7 +145,6 @@ QRadioTuner::~QRadioTuner()
|
||||
|
||||
/*!
|
||||
Returns true if the radio tuner service is ready to use.
|
||||
\since 1.0
|
||||
*/
|
||||
bool QRadioTuner::isAvailable() const
|
||||
{
|
||||
@@ -159,7 +156,6 @@ bool QRadioTuner::isAvailable() const
|
||||
|
||||
/*!
|
||||
Returns the availability error state.
|
||||
\since 1.0
|
||||
*/
|
||||
QtMultimedia::AvailabilityError QRadioTuner::availabilityError() const
|
||||
{
|
||||
@@ -173,7 +169,6 @@ QtMultimedia::AvailabilityError QRadioTuner::availabilityError() const
|
||||
\property QRadioTuner::state
|
||||
Return the current radio tuner state.
|
||||
|
||||
\since 1.0
|
||||
\sa QRadioTuner::State
|
||||
*/
|
||||
|
||||
@@ -187,7 +182,6 @@ QRadioTuner::State QRadioTuner::state() const
|
||||
\property QRadioTuner::band
|
||||
\brief the frequency band a radio tuner is tuned to.
|
||||
|
||||
\since 1.0
|
||||
\sa QRadioTuner::Band
|
||||
*/
|
||||
|
||||
@@ -204,7 +198,6 @@ QRadioTuner::Band QRadioTuner::band() const
|
||||
/*!
|
||||
\property QRadioTuner::frequency
|
||||
\brief the frequency in Hertz a radio tuner is tuned to.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
int QRadioTuner::frequency() const
|
||||
@@ -220,7 +213,6 @@ int QRadioTuner::frequency() const
|
||||
/*!
|
||||
Returns the number of Hertz to increment the frequency by when stepping through frequencies
|
||||
within a given \a band.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
int QRadioTuner::frequencyStep(QRadioTuner::Band band) const
|
||||
@@ -235,7 +227,6 @@ int QRadioTuner::frequencyStep(QRadioTuner::Band band) const
|
||||
|
||||
/*!
|
||||
Returns a frequency \a band's minimum and maximum frequency.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QPair<int,int> QRadioTuner::frequencyRange(QRadioTuner::Band band) const
|
||||
@@ -251,7 +242,6 @@ QPair<int,int> QRadioTuner::frequencyRange(QRadioTuner::Band band) const
|
||||
/*!
|
||||
\property QRadioTuner::stereo
|
||||
\brief whether a radio tuner is receiving a stereo signal.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
bool QRadioTuner::isStereo() const
|
||||
@@ -268,7 +258,6 @@ bool QRadioTuner::isStereo() const
|
||||
/*!
|
||||
\property QRadioTuner::stereoMode
|
||||
\brief the stereo mode of a radio tuner.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
QRadioTuner::StereoMode QRadioTuner::stereoMode() const
|
||||
@@ -293,7 +282,6 @@ void QRadioTuner::setStereoMode(QRadioTuner::StereoMode mode)
|
||||
Identifies if a frequency \a band is supported by a radio tuner.
|
||||
|
||||
Returns true if the band is supported, and false if it is not.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
bool QRadioTuner::isBandSupported(QRadioTuner::Band band) const
|
||||
@@ -308,7 +296,6 @@ bool QRadioTuner::isBandSupported(QRadioTuner::Band band) const
|
||||
|
||||
/*!
|
||||
Activate the radio device.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QRadioTuner::start()
|
||||
@@ -321,7 +308,6 @@ void QRadioTuner::start()
|
||||
|
||||
/*!
|
||||
Deactivate the radio device.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QRadioTuner::stop()
|
||||
@@ -335,7 +321,6 @@ void QRadioTuner::stop()
|
||||
/*!
|
||||
\property QRadioTuner::signalStrength
|
||||
\brief the strength of the current radio signal as a percentage.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
int QRadioTuner::signalStrength() const
|
||||
@@ -351,7 +336,6 @@ int QRadioTuner::signalStrength() const
|
||||
/*!
|
||||
\property QRadioTuner::volume
|
||||
\brief the volume of a radio tuner's audio output as a percentage.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
|
||||
@@ -368,7 +352,6 @@ int QRadioTuner::volume() const
|
||||
/*!
|
||||
\property QRadioTuner::muted
|
||||
\brief whether a radio tuner's audio output is muted.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
bool QRadioTuner::isMuted() const
|
||||
@@ -385,7 +368,6 @@ bool QRadioTuner::isMuted() const
|
||||
Sets a radio tuner's frequency \a band.
|
||||
|
||||
Changing the band will reset the \l frequency to the new band's minimum frequency.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QRadioTuner::setBand(QRadioTuner::Band band)
|
||||
@@ -401,7 +383,6 @@ void QRadioTuner::setBand(QRadioTuner::Band band)
|
||||
|
||||
If the tuner is set to a frequency outside the current \l band, the band will be changed to
|
||||
one occupied by the new frequency.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
void QRadioTuner::setFrequency(int frequency)
|
||||
@@ -433,7 +414,6 @@ void QRadioTuner::setMuted(bool muted)
|
||||
\brief whether a radio tuner is currently scanning for a signal.
|
||||
|
||||
\sa searchForward(), searchBackward(), cancelSearch()
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
bool QRadioTuner::isSearching() const
|
||||
@@ -449,7 +429,6 @@ bool QRadioTuner::isSearching() const
|
||||
/*!
|
||||
Starts a forward scan for a signal, starting from the current \l frequency.
|
||||
|
||||
\since 1.0
|
||||
\sa searchBackward(), cancelSearch(), searching
|
||||
*/
|
||||
|
||||
@@ -464,7 +443,6 @@ void QRadioTuner::searchForward()
|
||||
/*!
|
||||
Starts a backwards scan for a signal, starting from the current \l frequency.
|
||||
|
||||
\since 1.0
|
||||
\sa searchForward(), cancelSearch(), searching
|
||||
*/
|
||||
|
||||
@@ -484,7 +462,6 @@ void QRadioTuner::searchBackward()
|
||||
emitted (false). If \a searchMode is set to SearchGetStationId, searching
|
||||
waits for station id (PI) on each frequency.
|
||||
|
||||
\since 5.0
|
||||
\sa searchForward(), searchBackward(), searching
|
||||
*/
|
||||
|
||||
@@ -499,7 +476,6 @@ void QRadioTuner::searchAllStations(QRadioTuner::SearchMode searchMode)
|
||||
/*!
|
||||
Stops scanning for a signal.
|
||||
|
||||
\since 1.0
|
||||
\sa searchForward(), searchBackward(), searching
|
||||
*/
|
||||
|
||||
@@ -514,7 +490,6 @@ void QRadioTuner::cancelSearch()
|
||||
/*!
|
||||
Returns the error state of a radio tuner.
|
||||
|
||||
\since 1.0
|
||||
\sa errorString()
|
||||
*/
|
||||
|
||||
@@ -531,7 +506,6 @@ QRadioTuner::Error QRadioTuner::error() const
|
||||
/*!
|
||||
Returns a description of a radio tuner's error state.
|
||||
|
||||
\since 1.0
|
||||
\sa error()
|
||||
*/
|
||||
|
||||
@@ -549,49 +523,42 @@ QString QRadioTuner::errorString() const
|
||||
\fn void QRadioTuner::bandChanged(QRadioTuner::Band band)
|
||||
|
||||
Signals a radio tuner's \a band has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTuner::frequencyChanged(int frequency)
|
||||
|
||||
Signals that the \a frequency a radio tuner is tuned to has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTuner::mutedChanged(bool muted)
|
||||
|
||||
Signals that the \a muted state of a radio tuner's audio output has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTuner::volumeChanged(int volume)
|
||||
|
||||
Signals that the \a volume of a radio tuner's audio output has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTuner::searchingChanged(bool searching)
|
||||
|
||||
Signals that the \a searching state of a radio tuner has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTuner::stereoStatusChanged(bool stereo)
|
||||
|
||||
Signals that the \a stereo state of a radio tuner has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTuner::signalStrengthChanged(int strength)
|
||||
|
||||
Signals that the \a strength of the signal received by a radio tuner has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
@@ -599,14 +566,12 @@ QString QRadioTuner::errorString() const
|
||||
|
||||
Signals that a station was found in \a frequency with \a stationId Program
|
||||
Identification code.
|
||||
\since 5.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTuner::error(QRadioTuner::Error error)
|
||||
|
||||
Signals that an \a error occurred.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
@@ -654,7 +619,6 @@ QString QRadioTuner::errorString() const
|
||||
|
||||
/*! \fn void QRadioTuner::stateChanged(QRadioTuner::State state)
|
||||
This signal is emitted when the state changes to \a state.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
#include "moc_qradiotuner.cpp"
|
||||
|
||||
Reference in New Issue
Block a user