Added documentation for the Radio and RadioData QML elements.

Change-Id: I60c98b23138664543a1738ae93043432f66c8ab8
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>

src/imports/multimedia/qdeclarativeradiodata.cpp

@@ -43,6 +43,57 @@
 
 QT_BEGIN_NAMESPACE
 
+/*!
+    \qmlclass RadioData QDeclarativeRadioData
+    \since 5.0.0
+    \brief The RadioData element allows you to access RDS data from a QML application.
+    \ingroup qml-multimedia
+    \inherits Item
+
+    This element is part of the \bold{QtMultimedia 5.0} module.
+
+    The \c RadioData element is your gateway to all the data available through RDS. RDS is the Radio Data System
+    which allows radio stations to broadcast information like the \l stationId, \l programType, \l programTypeName,
+    \l stationName, and \l radioText. This information can be read from the \c RadioData element. It also allows
+    you to set whether the radio should tune to alternative frequencies if the current signal strength falls too much.
+
+    \qml
+    import QtQuick 2.0
+    import QtMultimedia 5.0
+
+    Rectangle {
+        width: 480
+        height: 320
+
+        Radio {
+            id: radio
+            band: Radio.FM
+        }
+
+        RadioData {
+            id: radioData
+        }
+
+        Column {
+            Text {
+                text: radioData.stationName
+            }
+
+            Text {
+                text: radioData.programTypeName
+            }
+
+            Text {
+                text: radioData.radioText
+            }
+        }
+    }
+
+    \endqml
+
+    You use \c RadioData together with the \l Radio element. The properties of the RadioData element will reflect the
+    information broadcast by the radio station the Radio element is currently tuned to.
+*/
 QDeclarativeRadioData::QDeclarativeRadioData(QObject *parent) :
     QObject(parent),
     m_radioData(0)
@@ -66,36 +117,131 @@ QDeclarativeRadioData::~QDeclarativeRadioData()
 {
 }
 
+/*!
+    \qmlmethod bool RadioData::isAvailable()
+
+    Returns whether the radio data element is ready to use.
+  */
 bool QDeclarativeRadioData::isAvailable() const
 {
     return m_radioData->isAvailable();
 }
 
+/*!
+    \qmlproperty string RadioData::stationId
+
+    This property allows you to read the station Id of the currently tuned radio
+    station.
+  */
 QString QDeclarativeRadioData::stationId() const
 {
     return m_radioData->stationId();
 }
 
+/*!
+    \qmlproperty enumeration RadioData::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.
+
+    \table
+    \header \o Value
+        \row \o Undefined
+        \row \o News
+        \row \o CurrentAffairs
+        \row \o Information
+        \row \o Sport
+        \row \o Education
+        \row \o Drama
+        \row \o Culture
+        \row \o Science
+        \row \o Varied
+        \row \o PopMusic
+        \row \o RockMusic
+        \row \o EasyListening
+        \row \o LightClassical
+        \row \o SeriousClassical
+        \row \o OtherMusic
+        \row \o Weather
+        \row \o Finance
+        \row \o ChildrensProgrammes
+        \row \o SocialAffairs
+        \row \o Religion
+        \row \o PhoneIn
+        \row \o Travel
+        \row \o Leisure
+        \row \o JazzMusic
+        \row \o CountryMusic
+        \row \o NationalMusic
+        \row \o OldiesMusic
+        \row \o FolkMusic
+        \row \o Documentary
+        \row \o AlarmTest
+        \row \o Alarm
+        \row \o Talk
+        \row \o ClassicRock
+        \row \o AdultHits
+        \row \o SoftRock
+        \row \o Top40
+        \row \o Soft
+        \row \o Nostalgia
+        \row \o Classical
+        \row \o RhythmAndBlues
+        \row \o SoftRhythmAndBlues
+        \row \o Language
+        \row \o ReligiousMusic
+        \row \o ReligiousTalk
+        \row \o Personality
+        \row \o Public
+        \row \o College
+
+    \endtable
+  */
 QDeclarativeRadioData::ProgramType QDeclarativeRadioData::programType() const
 {
     return static_cast<QDeclarativeRadioData::ProgramType>(m_radioData->programType());
 }
 
+/*!
+    \qmlproperty string RadioData::programTypeName
+
+    This property holds a string representation of the \l programType.
+  */
 QString QDeclarativeRadioData::programTypeName() const
 {
     return m_radioData->programTypeName();
 }
 
+/*!
+    \qmlproperty string RadioData::stationName
+
+    This property has the name of the currently tuned radio station.
+  */
 QString QDeclarativeRadioData::stationName() const
 {
     return m_radioData->stationName();
 }
 
+/*!
+    \qmlproperty string RadioData::radioText
+
+    This property holds free-text transmitted by the radio station. This is typically used to
+    show supporting information for the currently playing content, for instance song title or
+    artist name.
+  */
 QString QDeclarativeRadioData::radioText() const
 {
     return m_radioData->radioText();
 }
 
+/*!
+    \qmlproperty bool RadioData::alternativeFrequenciesEnabled
+
+    This property allows you to specify whether the radio should try and tune to alternative
+    frequencies if the signal strength of the current station becomes too weak. The alternative
+    frequencies are emitted over RDS by the radio station, and the tuning happens automatically.
+  */
 bool QDeclarativeRadioData::alternativeFrequenciesEnabled() const
 {
     return m_radioData->isAlternativeFrequenciesEnabled();