Correction to qml-wrapper documentation

Format documentation for enumerations properly

Change-Id: If3e5b6a642a84526696ba94c84e20bd4866b5dda
Reviewed-by: Cristiano di Flora <cristiano.di-flora@nokia.com>

6 files changed, 92 insertions, 92 deletions

diff --git a/src/imports/systeminfo/qdeclarativebatteryinfo.cpp b/src/imports/systeminfo/qdeclarativebatteryinfo.cpp
index 6253b844..6125061c 100644
--- a/src/imports/systeminfo/qdeclarativebatteryinfo.cpp
+++ b/src/imports/systeminfo/qdeclarativebatteryinfo.cpp
@@ -140,14 +140,14 @@ void QDeclarativeBatteryInfo::setMonitorChargerType(bool monitor)
 }
 
 /*!
-    \qmlproperty enum BatteryInfo::chargerType
+    \qmlproperty enumeration BatteryInfo::chargerType
 
     This property holds the type of the charger. Possible values are:
     \list
-    \li BatteryInfo.UnknownCharger
-    \li BatteryInfo.WallCharger
-    \li BatteryInfo.USBCharger
-    \li BatteryInfo.VariableCurrentCharger
+    \li BatteryInfo.UnknownCharger           - The charger type is unknown, or no charger.
+    \li BatteryInfo.WallCharger              - Using wall (mains) charger.
+    \li BatteryInfo.USBCharger               - Using USB charger when the system cannot differentiate the current.
+    \li BatteryInfo.VariableCurrentCharger   - Using variable current charger such as bicycle or solar.
     \endlist
 */
 QDeclarativeBatteryInfo::ChargerType QDeclarativeBatteryInfo::chargerType() const
@@ -384,11 +384,11 @@ void QDeclarativeBatteryInfo::setMonitorChargingState(bool monitor)
 
     Returns the charging state of the given \a battery. Possible values are:
     \list
-    \li BatteryInfo.UnknownChargingState
-    \li BatteryInfo.NotCharging
-    \li BatteryInfo.Charging
-    \li BatteryInfo.Discharging
-    \li BatteryInfo.Full
+    \li BatteryInfo.UnknownChargingState  - The charging state is unknown or charging error occured.
+    \li BatteryInfo.NotCharging           - The battery is not charging, i.e. too low charger power.
+    \li BatteryInfo.Charging              - The battery is charging.
+    \li BatteryInfo.Discharging           - The battery is discharging.
+    \li BatteryInfo.Full                  - The battery is fully charged.
     \endlist
 
     \sa onChargingStateChanged
@@ -412,13 +412,13 @@ void QDeclarativeBatteryInfo::_q_chargingStateChanged(int battery, QBatteryInfo:
 }
 
 /*!
-    \qmlproperty enum BatteryInfo::energyUnit
+    \qmlproperty enumeration BatteryInfo::energyUnit
 
     This property holds the energy unit used. Possible values are:
     \list
-    \li BatteryInfo.UnitUnknown
-    \li BatteryInfo.UnitmAh
-    \li BatteryInfo.UnitmWh
+    \li BatteryInfo.UnitUnknown            - Energy unit unknown.
+    \li BatteryInfo.UnitmAh                - Energy described in milliamp-hour (mAh)
+    \li BatteryInfo.UnitmWh                - Energy described in milliwatt-hour (mWh)
     \endlist
 */
 QDeclarativeBatteryInfo::EnergyUnit QDeclarativeBatteryInfo::energyUnit() const
@@ -468,11 +468,11 @@ void QDeclarativeBatteryInfo::setMonitorBatteryStatus(bool monitor)
 
     Returns the status of the given \a battery. Possible values are:
     \list
-    \li BatteryInfo.BatteryStatusUnknown
-    \li BatteryInfo.BatteryEmpty
-    \li BatteryInfo.BatteryLow
-    \li BatteryInfo.BatteryOk
-    \li BatteryInfo.BatteryFull
+    \li BatteryInfo.BatteryStatusUnknown      - Battery level undetermined.
+    \li BatteryInfo.BatteryEmpty              - Battery is considered be empty and device needs to shut down.
+    \li BatteryInfo.BatteryLow                - Battery level is low and warnings need to be issued to the user.
+    \li BatteryInfo.BatteryOk                 - Battery level is Ok. It is above "Low" but not "Full".
+    \li BatteryInfo.BatteryFull               - Battery is fully charged.
     \endlist
 
     \sa onBatteryStatusChanged
diff --git a/src/imports/systeminfo/qdeclarativedeviceinfo.cpp b/src/imports/systeminfo/qdeclarativedeviceinfo.cpp
index 528ae27f..b041bc8a 100644
--- a/src/imports/systeminfo/qdeclarativedeviceinfo.cpp
+++ b/src/imports/systeminfo/qdeclarativedeviceinfo.cpp
@@ -72,10 +72,10 @@ QDeclarativeDeviceInfo::~QDeclarativeDeviceInfo()
 
     This property holds the activated locks. Available locks include:
     \list
-    \li NoLock               No lock.
-    \li PinLock              Device can be locked by PIN code or password.
-    \li TouchOrKeyboardLock  Device can be locked by touch or keyboard.
-    \li UnknownLock          lock types requested but no result received yet.
+    \li DeviceInfo.NoLock               - No lock.
+    \li DeviceInfo.PinLock              - Device can be locked by PIN code or password.
+    \li DeviceInfo.TouchOrKeyboardLock  - Device can be locked by touch or keyboard.
+    \li DeviceInfo.UnknownLock          - Lock types requested but no result received yet.
     \endlist
 */
 QDeclarativeDeviceInfo::LockTypeFlags QDeclarativeDeviceInfo::activatedLocks() const
@@ -99,10 +99,10 @@ QDeclarativeDeviceInfo::LockTypeFlags QDeclarativeDeviceInfo::activatedLocks() c
 
     This property holds the enabled locks. Available locks include:
     \list
-    \li NoLock               No lock.
-    \li PinLock              Device can be locked by PIN code or password.
-    \li TouchOrKeyboardLock  Device can be locked by touch or keyboard.
-    \li UnknownLock          lock types requested but no result received yet.
+    \li DeviceInfo.NoLock               - No lock.
+    \li DeviceInfo.PinLock              - Device can be locked by PIN code or password.
+    \li DeviceInfo.TouchOrKeyboardLock  - Device can be locked by touch or keyboard.
+    \li DeviceInfo.UnknownLock          - Lock types requested but no result received yet.
     \endlist
 */
 QDeclarativeDeviceInfo::LockTypeFlags QDeclarativeDeviceInfo::enabledLocks() const
@@ -147,15 +147,15 @@ void QDeclarativeDeviceInfo::setMonitorThermalState(bool monitor)
 }
 
 /*!
-    \qmlproperty enum DeviceInfo::thermalState
+    \qmlproperty enumeration DeviceInfo::thermalState
 
     This property holds the thermal state. Possible values are:
     \list
-    \li UnknownThermal
-    \li NormalThermal
-    \li WarningThermal
-    \li AlertThermal
-    \li ErrorThermal
+    \li DeviceInfo.UnknownThermal   - The thermal state is unknown.
+    \li DeviceInfo.NormalThermal    - The thermal state is normal.
+    \li DeviceInfo.WarningThermal   - The thermal state is warning.
+    \li DeviceInfo.AlertThermal     - The thermal state is alert.
+    \li DeviceInfo.ErrorThermal     - The thermal state is error.
     \endlist
 */
 QDeclarativeDeviceInfo::ThermalState QDeclarativeDeviceInfo::thermalState() const
@@ -169,21 +169,21 @@ QDeclarativeDeviceInfo::ThermalState QDeclarativeDeviceInfo::thermalState() cons
     Returns true if the \a feature is supported, otherwise false. The following features can be
     queried:
     \list
-    \li BluetoothFeature      Bluetooth feature.
-    \li CameraFeature         Camera feature.
-    \li FmRadioFeature        Frequency modulation (FM) radio feature.
-    \li FmTransmitterFeature  Frequency modulation (FM) radio transmitter feature.
-    \li InfraredFeature       Infrared communication feature.
-    \li LedFeature            Light-emitting diode (LED) feature.
-    \li MemoryCardFeature     Memory card feature.
-    \li UsbFeature            Universal system bus (USB) feature.
-    \li VibrationFeature      Vibration feature.
-    \li WlanFeature           Wireless local area network (WLAN) feature.
-    \li SimFeature            Subscriber identity module (SIM) feature.
-    \li PositioningFeature    Positioning feature, e.g. Global Positioning System (GPS).
-    \li VideoOutFeature       Video out feature.
-    \li HapticsFeature        Haptics feature, the platform can provide audio and/or visual and/or vibration feedback.
-    \li NfcFeature            Near Field Communication (NFC) feature
+    \li DeviceInfo.BluetoothFeature      - Bluetooth feature.
+    \li DeviceInfo.CameraFeature         - Camera feature.
+    \li DeviceInfo.FmRadioFeature        - Frequency modulation (FM) radio feature.
+    \li DeviceInfo.FmTransmitterFeature  - Frequency modulation (FM) radio transmitter feature.
+    \li DeviceInfo.InfraredFeature       - Infrared communication feature.
+    \li DeviceInfo.LedFeature            - Light-emitting diode (LED) feature.
+    \li DeviceInfo.MemoryCardFeature     - Memory card feature.
+    \li DeviceInfo.UsbFeature            - Universal system bus (USB) feature.
+    \li DeviceInfo.VibrationFeature      - Vibration feature.
+    \li DeviceInfo.WlanFeature           - Wireless local area network (WLAN) feature.
+    \li DeviceInfo.SimFeature            - Subscriber identity module (SIM) feature.
+    \li DeviceInfo.PositioningFeature    - Positioning feature, e.g. Global Positioning System (GPS).
+    \li DeviceInfo.VideoOutFeature       - Video out feature.
+    \li DeviceInfo.HapticsFeature        - Haptics feature, the platform can provide audio and/or visual and/or vibration feedback.
+    \li DeviceInfo.NfcFeature            - Near Field Communication (NFC) feature
     \endlist
 */
 bool QDeclarativeDeviceInfo::hasFeature(QDeclarativeDeviceInfo::Feature feature) const
@@ -264,10 +264,10 @@ QString QDeclarativeDeviceInfo::uniqueDeviceID() const
     Returns the version of \a type. In case of error, or the version is unknown, an empty string
     is returned. The following versions can be queried:
     \list
-    \li Os        Operating system version. For Linux, it returns the version of the
-                 distribution if any.
-    \li Firmware  Version of (flashable) system as a whole. For Linux, it's the version
-                 of the kernel.
+    \li DeviceInfo.Os         - Operating system version. For Linux, it returns the version of the
+                                distribution if any.
+    \li DeviceInfo.Firmware   - Version of (flashable) system as a whole. For Linux, it's the version
+                                of the kernel.
     \endlist
 */
 QString QDeclarativeDeviceInfo::version(QDeclarativeDeviceInfo::Version type) const
diff --git a/src/imports/systeminfo/qdeclarativedeviceprofile.cpp b/src/imports/systeminfo/qdeclarativedeviceprofile.cpp
index 42eacc6b..c591c8f7 100644
--- a/src/imports/systeminfo/qdeclarativedeviceprofile.cpp
+++ b/src/imports/systeminfo/qdeclarativedeviceprofile.cpp
@@ -110,15 +110,15 @@ int QDeclarativeDeviceProfile::voiceRingtoneVolume() const
 }
 
 /*!
-    \qmlproperty enum DeviceProfile::currentProfileType
+    \qmlproperty enumeration DeviceProfile::currentProfileType
 
     Returns the type of the current profile, possible types are:
     \list
-    \li UnknownProfile    Profile unknown, profile type requested but no result received yet or an error occured.
-    \li SilentProfile     Neither sound nor vibration is on.
-    \li NormalProfile     Normal sound is on.
-    \li VibrationProfile  Only vibration is on, and sound is off.
-    \li BeepProfile       Only beep is on.
+    \li DeviceProfile.UnknownProfile    - Profile unknown, profile type requested but no result received yet or an error occured.
+    \li DeviceProfile.SilentProfile     - Neither sound nor vibration is on.
+    \li DeviceProfile.NormalProfile     - Normal sound is on.
+    \li DeviceProfile.VibrationProfile  - Only vibration is on, and sound is off.
+    \li DeviceProfile.BeepProfile       - Only beep is on.
     \endlist
  */
 
diff --git a/src/imports/systeminfo/qdeclarativedisplayinfo.cpp b/src/imports/systeminfo/qdeclarativedisplayinfo.cpp
index 187d184c..764bdc97 100644
--- a/src/imports/systeminfo/qdeclarativedisplayinfo.cpp
+++ b/src/imports/systeminfo/qdeclarativedisplayinfo.cpp
@@ -149,10 +149,10 @@ int QDeclarativeDisplayInfo::physicalWidth(int screen) const
 
     Returns the backlight state of the given \a screen. Possible values are:
     \list
-    \li BacklightUnknown  The state of the backlight is unkown.
-    \li BacklightOff      Backlight is turned off.
-    \li BacklightDimmed   Backlight has been dimmed.
-    \li BacklightOn       Backlight is on.
+    \li DisplayInfo.BacklightUnknown  - The state of the backlight is unkown.
+    \li DisplayInfo.BacklightOff      - Backlight is turned off.
+    \li DisplayInfo.BacklightDimmed   - Backlight has been dimmed.
+    \li DisplayInfo.BacklightOn       - Backlight is on.
     \endlist
 */
 int QDeclarativeDisplayInfo::backlightState(int screen) const
diff --git a/src/imports/systeminfo/qdeclarativenetworkinfo.cpp b/src/imports/systeminfo/qdeclarativenetworkinfo.cpp
index 2cafa472..c1da02cf 100644
--- a/src/imports/systeminfo/qdeclarativenetworkinfo.cpp
+++ b/src/imports/systeminfo/qdeclarativenetworkinfo.cpp
@@ -113,20 +113,20 @@ void QDeclarativeNetworkInfo::setMonitorCurrentNetworkMode(bool monitor)
 }
 
 /*!
-    \qmlproperty enum NetworkInfo::currentNetworkMode
+    \qmlproperty enumeration NetworkInfo::currentNetworkMode
 
     This property holds the current network mode. Possible values are:
     \list
-    \li UnknownMode
-    \li GsmMode
-    \li CdmaMode
-    \li WcdmaMode
-    \li WlanMode
-    \li EthernetMode
-    \li BluetoothMode
-    \li WimaxMode
-    \li LteMode
-    \li TdscdmaMode
+    \li NetworkInfo.UnknownMode     - The network is unknown or an error occured.
+    \li NetworkInfo.GsmMode         - Global System for Mobile (GSM) network.
+    \li NetworkInfo.CdmaMode        - Code Division Multiple Access (CDMA) network.
+    \li NetworkInfo.WcdmaMode       - Wideband Code Division Multiple Access (WCDMA) network.
+    \li NetworkInfo.WlanMode        - Wireless local area network (WLAN) network.
+    \li NetworkInfo.EthernetMode    - Local area network (LAN), or Ethernet network.
+    \li NetworkInfo.BluetoothMode   - Bluetooth network.
+    \li NetworkInfo.WimaxMode       - Worldwide Interoperability for Microwave Access (WiMAX) network.
+    \li NetworkInfo.LteMode         - 3GPP Long Term Evolution (LTE) network.
+    \li NetworkInfo.TdscdmaMode     - Time Division Synchronous Code Division Multiple Access (TD-SCDMA) network.
     \endlist
  */
 QDeclarativeNetworkInfo::NetworkMode QDeclarativeNetworkInfo::currentNetworkMode() const
@@ -263,11 +263,11 @@ void QDeclarativeNetworkInfo::setMonitorCurrentCellDataTechnology(bool monitor)
 
     Returns the current cell data technology of the given \a interface. Possible values are:
     \list
-    \li UnknownDataTechnology
-    \li GprsDataTechnology
-    \li EdgeDataTechnology
-    \li UmtsDataTechnology
-    \li HspaDataTechnology
+    \li NetworkInfo.UnknownDataTechnology   - The cellular technology is unknown or an error occured.
+    \li NetworkInfo.GprsDataTechnology      - General Packet Radio Service (GPRS) data service.
+    \li NetworkInfo.EdgeDataTechnology      - Enhanced Data Rates for GSM Evolution (EDGE) data service.
+    \li NetworkInfo.UmtsDataTechnology      - Universal Mobile Telecommunications System (UMTS) data service.
+    \li NetworkInfo.HspaDataTechnology      - High Speed Packet Access (HSPA) data service.
     \endlist
  */
 int QDeclarativeNetworkInfo::currentCellDataTechnology(int interface) const
@@ -318,14 +318,14 @@ void QDeclarativeNetworkInfo::setMonitorNetworkStatus(bool monitor)
 
     Returns the status of the given \a mode and \a interface. Possible values are:
     \list
-    \li UnknownStatus
-    \li NoNetworkAvailable
-    \li EmergencyOnly
-    \li Searching
-    \li Busy
-    \li Denied
-    \li HomeNetwork
-    \li Roaming
+    \li NetworkInfo.UnknownStatus        - The status is unknown or an error occured.
+    \li NetworkInfo.NoNetworkAvailable   - There is no network available.
+    \li NetworkInfo.EmergencyOnly        - The network only allows emergency calls.
+    \li NetworkInfo.Searching            - The device is searching or connecting to the network.
+    \li NetworkInfo.Busy                 - The network is too busy to be connected.
+    \li NetworkInfo.Denied               - The connection to the network has been denied.
+    \li NetworkInfo.HomeNetwork          - The device is connected to the home network.
+    \li NetworkInfo.Roaming              - The device is connected to some roaming network.
     \endlist
  */
 int QDeclarativeNetworkInfo::networkStatus(QDeclarativeNetworkInfo::NetworkMode mode, int interface) const
diff --git a/src/imports/systeminfo/qdeclarativestorageinfo.cpp b/src/imports/systeminfo/qdeclarativestorageinfo.cpp
index e8515c42..398e926c 100644
--- a/src/imports/systeminfo/qdeclarativestorageinfo.cpp
+++ b/src/imports/systeminfo/qdeclarativestorageinfo.cpp
@@ -142,12 +142,12 @@ QString QDeclarativeStorageInfo::uriForDrive(const QString &drive) const
 
     Returns the type of the given \a drive. Possible values are:
     \list
-    \li UnknownDrive    Drive type unknown.
-    \li InternalDrive   Internal mass storage drive, e.g. hard drive.
-    \li RemovableDrive  Removable drive, e.g. memory card.
-    \li RemoteDrive     Network drive.
-    \li CdromDrive      CD-ROM.
-    \li RamDrive        Virtual drive made in RAM memory.
+    \li StorageInfo.UnknownDrive    - Drive type unknown.
+    \li StorageInfo.InternalDrive   - Internal mass storage drive, e.g. hard drive.
+    \li StorageInfo.RemovableDrive  - Removable drive, e.g. memory card.
+    \li StorageInfo.RemoteDrive     - Network drive.
+    \li StorageInfo.CdromDrive      - CD-ROM.
+    \li StorageInfo.RamDrive        - Virtual drive made in RAM memory.
     \endlist
 */
 int QDeclarativeStorageInfo::driveType(const QString &drive) const