Doc: Removing version number from the QDoc comments.
The version is not needed anymore and QDoc handles them as a different module, causing errors. Task-number: QTBUG-32172 Change-Id: I55054a6c7bce9e001ef03cce944b03375c851d15 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
committed by
The Qt Project
parent
40908fdb77
commit
43be5d9763
@@ -126,7 +126,7 @@ QDeclarativeRadio::~QDeclarativeRadio()
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty enumeration QtMultimedia5::Radio::state
|
||||
\qmlproperty enumeration QtMultimedia::Radio::state
|
||||
|
||||
This property holds the current state of the Radio.
|
||||
|
||||
@@ -148,7 +148,7 @@ QDeclarativeRadio::State QDeclarativeRadio::state() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty enumeration QtMultimedia5::Radio::band
|
||||
\qmlproperty enumeration QtMultimedia::Radio::band
|
||||
|
||||
This property holds the frequency band used for the radio, which can be specified as
|
||||
any one of the values in the table below.
|
||||
@@ -178,7 +178,7 @@ QDeclarativeRadio::Band QDeclarativeRadio::band() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::Radio::frequency
|
||||
\qmlproperty int QtMultimedia::Radio::frequency
|
||||
|
||||
Sets the frequency in Hertz that the radio is tuned to. The frequency must be within the frequency
|
||||
range for the current band, otherwise it will be changed to be within the frequency range.
|
||||
@@ -191,7 +191,7 @@ int QDeclarativeRadio::frequency() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty enumeration QtMultimedia5::Radio::stereoMode
|
||||
\qmlproperty enumeration QtMultimedia::Radio::stereoMode
|
||||
|
||||
This property holds the stereo mode of the radio, which can be set to any one of the
|
||||
values in the table below.
|
||||
@@ -215,7 +215,7 @@ QDeclarativeRadio::StereoMode QDeclarativeRadio::stereoMode() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::Radio::volume
|
||||
\qmlproperty int QtMultimedia::Radio::volume
|
||||
|
||||
Set this property to control the volume of the radio. The valid range of the volume is from 0 to 100.
|
||||
*/
|
||||
@@ -225,7 +225,7 @@ int QDeclarativeRadio::volume() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty bool QtMultimedia5::Radio::muted
|
||||
\qmlproperty bool QtMultimedia::Radio::muted
|
||||
|
||||
This property reflects whether the radio is muted or not.
|
||||
*/
|
||||
@@ -235,7 +235,7 @@ bool QDeclarativeRadio::muted() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty bool QtMultimedia5::Radio::stereo
|
||||
\qmlproperty bool QtMultimedia::Radio::stereo
|
||||
|
||||
This property holds whether the radio is receiving a stereo signal or not. If \l stereoMode is
|
||||
set to ForceMono the value will always be false. Likewise, it will always be true if stereoMode
|
||||
@@ -249,7 +249,7 @@ bool QDeclarativeRadio::stereo() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::Radio::signalStrength
|
||||
\qmlproperty int QtMultimedia::Radio::signalStrength
|
||||
|
||||
The strength of the current radio signal as a percentage where 0% equals no signal, and 100% is a
|
||||
very good signal.
|
||||
@@ -260,7 +260,7 @@ int QDeclarativeRadio::signalStrength() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty bool QtMultimedia5::Radio::searching
|
||||
\qmlproperty bool QtMultimedia::Radio::searching
|
||||
|
||||
This property is true if the radio is currently searching for radio stations, for instance using the \l scanUp,
|
||||
\l scanDown, and \l searchAllStations methods. Once the search completes, or if it is cancelled using
|
||||
@@ -272,7 +272,7 @@ bool QDeclarativeRadio::searching() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::Radio::frequencyStep
|
||||
\qmlproperty int QtMultimedia::Radio::frequencyStep
|
||||
|
||||
The number of Hertz for each step when tuning the radio manually. The value is for the current \l band.
|
||||
*/
|
||||
@@ -282,7 +282,7 @@ int QDeclarativeRadio::frequencyStep() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::Radio::minimumFrequency
|
||||
\qmlproperty int QtMultimedia::Radio::minimumFrequency
|
||||
|
||||
The minimum frequency for the current \l band.
|
||||
*/
|
||||
@@ -292,7 +292,7 @@ int QDeclarativeRadio::minimumFrequency() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::Radio::maximumFrequency
|
||||
\qmlproperty int QtMultimedia::Radio::maximumFrequency
|
||||
|
||||
The maximum frequency for the current \l band.
|
||||
*/
|
||||
@@ -302,7 +302,7 @@ int QDeclarativeRadio::maximumFrequency() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::Radio::antennaConnected
|
||||
\qmlproperty int QtMultimedia::Radio::antennaConnected
|
||||
|
||||
This property is true if there is an antenna connected. Otherwise it will be false.
|
||||
*/
|
||||
@@ -312,7 +312,7 @@ bool QDeclarativeRadio::isAntennaConnected() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty enumeration QtMultimedia5::Radio::availability
|
||||
\qmlproperty enumeration QtMultimedia::Radio::availability
|
||||
|
||||
Returns the availability state of the radio.
|
||||
|
||||
@@ -367,7 +367,7 @@ void QDeclarativeRadio::setMuted(bool muted)
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::cancelScan()
|
||||
\qmlmethod QtMultimedia::Radio::cancelScan()
|
||||
|
||||
Cancel the current scan. Will also cancel a search started with \l searchAllStations.
|
||||
*/
|
||||
@@ -377,7 +377,7 @@ void QDeclarativeRadio::cancelScan()
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::scanDown()
|
||||
\qmlmethod QtMultimedia::Radio::scanDown()
|
||||
|
||||
Searches backward in the frequency range for the current band.
|
||||
*/
|
||||
@@ -387,7 +387,7 @@ void QDeclarativeRadio::scanDown()
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::scanUp()
|
||||
\qmlmethod QtMultimedia::Radio::scanUp()
|
||||
|
||||
Searches forward in the frequency range for the current band.
|
||||
*/
|
||||
@@ -397,7 +397,7 @@ void QDeclarativeRadio::scanUp()
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::searchAllStations(enumeration searchMode)
|
||||
\qmlmethod QtMultimedia::Radio::searchAllStations(enumeration searchMode)
|
||||
|
||||
Start searching the complete frequency range for the current band, and save all the
|
||||
radio stations found. The search mode can be either of the values described in the
|
||||
@@ -461,7 +461,7 @@ void QDeclarativeRadio::searchAllStations(QDeclarativeRadio::SearchMode searchMo
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::tuneDown()
|
||||
\qmlmethod QtMultimedia::Radio::tuneDown()
|
||||
|
||||
Decrements the frequency by the frequency step for the current band. If the frequency is already set
|
||||
to the minimum frequency, calling this function has no effect.
|
||||
@@ -476,7 +476,7 @@ void QDeclarativeRadio::tuneDown()
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::tuneUp()
|
||||
\qmlmethod QtMultimedia::Radio::tuneUp()
|
||||
|
||||
Increments the frequency by the frequency step for the current band. If the frequency is already set
|
||||
to the maximum frequency, calling this function has no effect.
|
||||
@@ -491,7 +491,7 @@ void QDeclarativeRadio::tuneUp()
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::start()
|
||||
\qmlmethod QtMultimedia::Radio::start()
|
||||
|
||||
Starts the radio. If the radio is available, as determined by the \l availability property,
|
||||
this will result in the \l state becoming \c ActiveState.
|
||||
@@ -502,7 +502,7 @@ void QDeclarativeRadio::start()
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::Radio::stop()
|
||||
\qmlmethod QtMultimedia::Radio::stop()
|
||||
|
||||
Stops the radio. After calling this method the \l state will be \c StoppedState.
|
||||
*/
|
||||
@@ -533,7 +533,7 @@ void QDeclarativeRadio::_q_availabilityChanged(QMultimedia::AvailabilityStatus a
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlsignal QtMultimedia5::Radio::stationFound(int frequency, string stationId)
|
||||
\qmlsignal QtMultimedia::Radio::stationFound(int frequency, string stationId)
|
||||
|
||||
This signal is emitted when a new radio station is found. This signal is only emitted
|
||||
if \l searchAllStations is called with \c SearchGetStationId.
|
||||
|
||||
Reference in New Issue
Block a user