summaryrefslogtreecommitdiffstats
path: root/src/multimedia/radio
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-01-17 13:10:20 +1000
committerQt by Nokia <qt-info@nokia.com>2012-01-17 05:19:02 +0100
commitb7fcfd4ea99f780bee5e4f26fbf276b39bdbded8 (patch)
tree326347e2c809660ead6f92083cc93871c0b37b21 /src/multimedia/radio
parent508ca281961a9dd59f21218adfa2305b6a4c8ac1 (diff)
More minor doc fixes.
- Missing enums - Misspelt \fn etc - Missing QSoundEffect C++ docs - A few typos etc Change-Id: I3418e79b5d50a7ab86e54d79676c33d06954bef5 Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
Diffstat (limited to 'src/multimedia/radio')
-rw-r--r--src/multimedia/radio/qradiodata.cpp70
-rw-r--r--src/multimedia/radio/qradiotuner.cpp9
2 files changed, 74 insertions, 5 deletions
diff --git a/src/multimedia/radio/qradiodata.cpp b/src/multimedia/radio/qradiodata.cpp
index a2891ca22..06dbb7742 100644
--- a/src/multimedia/radio/qradiodata.cpp
+++ b/src/multimedia/radio/qradiodata.cpp
@@ -302,7 +302,7 @@ QString QRadioData::errorString() const
*/
/*!
- \fn void QRadioData::stationNameChanged(int stationName)
+ \fn void QRadioData::stationNameChanged(QString stationName)
Signals that the Program Service has changed to \a stationName
*/
@@ -310,7 +310,14 @@ QString QRadioData::errorString() const
/*!
\fn void QRadioData::alternativeFrequenciesEnabledChanged(bool enabled)
- Signals that the AF has been enabled or disabled
+ Signals that automatically tuning to alternative frequencies has been
+ enabled or disabled according to \a enabled.
+*/
+
+/*!
+ \fn void QRadioData::radioTextChanged(QString radioText)
+
+ Signals that the Radio Text property has changed to \a radioText
*/
/*!
@@ -330,9 +337,62 @@ QString QRadioData::errorString() const
\value OutOfRangeError An attempt to set a frequency or band that is not supported by radio device.
*/
-/*! \fn void QRadioData::stateChanged(QRadioData::State state)
- This signal is emitted when the state changes to \a state.
- */
+/*!
+ \enum QRadioData::ProgramType
+
+ This property holds the type of the currently playing program as transmitted
+ by the radio station. The value can be any one of the values defined in the
+ table below.
+
+ \value Undefined
+ \value News
+ \value CurrentAffairs
+ \value Information
+ \value Sport
+ \value Education
+ \value Drama
+ \value Culture
+ \value Science
+ \value Varied
+ \value PopMusic
+ \value RockMusic
+ \value EasyListening
+ \value LightClassical
+ \value SeriousClassical
+ \value OtherMusic
+ \value Weather
+ \value Finance
+ \value ChildrensProgrammes
+ \value SocialAffairs
+ \value Religion
+ \value PhoneIn
+ \value Travel
+ \value Leisure
+ \value JazzMusic
+ \value CountryMusic
+ \value NationalMusic
+ \value OldiesMusic
+ \value FolkMusic
+ \value Documentary
+ \value AlarmTest
+ \value Alarm
+ \value Talk
+ \value ClassicRock
+ \value AdultHits
+ \value SoftRock
+ \value Top40
+ \value Soft
+ \value Nostalgia
+ \value Classical
+ \value RhythmAndBlues
+ \value SoftRhythmAndBlues
+ \value Language
+ \value ReligiousMusic
+ \value ReligiousTalk
+ \value Personality
+ \value Public
+ \value College
+*/
#include "moc_qradiodata.cpp"
QT_END_NAMESPACE
diff --git a/src/multimedia/radio/qradiotuner.cpp b/src/multimedia/radio/qradiotuner.cpp
index 9caa3ad07..9910ef76f 100644
--- a/src/multimedia/radio/qradiotuner.cpp
+++ b/src/multimedia/radio/qradiotuner.cpp
@@ -456,6 +456,15 @@ void QRadioTuner::searchBackward()
}
/*!
+ \enum QRadioTuner::SearchMode
+
+ Enumerates how the radio tuner should search for stations.
+
+ \value SearchFast Use only signal strength when searching.
+ \value SearchGetStationId After finding a strong signal, wait for the RDS station id (PI) before continuing.
+*/
+
+/*!
Search all stations in current band
Emits QRadioTuner::stationFound(int, QString) for every found station.