aboutsummaryrefslogtreecommitdiffstats
path: root/libqmi-glib/qmi-enums.h
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@lanedo.com>2012-10-08 13:17:01 +0200
committerAleksander Morgado <aleksander@lanedo.com>2012-10-09 12:20:55 +0200
commit75ccb48f4d0e9f2e29a4689ca8cce14b0ee7272e (patch)
tree55060c318c87683fffb02970a84c6e203468d2d1 /libqmi-glib/qmi-enums.h
parentb0b1fe322114380e0928ba6d9b499c7a22b16144 (diff)
downloadexternal_libqmi-75ccb48f4d0e9f2e29a4689ca8cce14b0ee7272e.zip
external_libqmi-75ccb48f4d0e9f2e29a4689ca8cce14b0ee7272e.tar.gz
external_libqmi-75ccb48f4d0e9f2e29a4689ca8cce14b0ee7272e.tar.bz2
libmm-glib: fix multiple documentation issues
Diffstat (limited to 'libqmi-glib/qmi-enums.h')
-rw-r--r--libqmi-glib/qmi-enums.h70
1 files changed, 54 insertions, 16 deletions
diff --git a/libqmi-glib/qmi-enums.h b/libqmi-glib/qmi-enums.h
index 755fee4..7e1a198 100644
--- a/libqmi-glib/qmi-enums.h
+++ b/libqmi-glib/qmi-enums.h
@@ -25,6 +25,31 @@
#ifndef _LIBQMI_GLIB_QMI_ENUMS_H_
#define _LIBQMI_GLIB_QMI_ENUMS_H_
+/**
+ * QmiService:
+ * @QMI_SERVICE_UNKNOWN: Unknown service.
+ * @QMI_SERVICE_CTL: Control service.
+ * @QMI_SERVICE_WDS: Wireless Data Service.
+ * @QMI_SERVICE_DMS: Device Management Service.
+ * @QMI_SERVICE_NAS: Network Access Service.
+ * @QMI_SERVICE_QOS: Quality Of Service service.
+ * @QMI_SERVICE_WMS: Wireless Messaging Service.
+ * @QMI_SERVICE_PDS: Position Determination Service.
+ * @QMI_SERVICE_AUTH: Authentication service.
+ * @QMI_SERVICE_AT: AT service.
+ * @QMI_SERVICE_VOICE: Voice service.
+ * @QMI_SERVICE_CAT2: Card Application Toolkit service (v2).
+ * @QMI_SERVICE_UIM: User Identity Module service.
+ * @QMI_SERVICE_PBM: Phonebook Management service.
+ * @QMI_SERVICE_LOC: Location service (~ PDS v2).
+ * @QMI_SERVICE_SAR: SAR.
+ * @QMI_SERVICE_RMTFS: Remote Filesystem service.
+ * @QMI_SERVICE_CAT: Card Application Toolkit service (v1).
+ * @QMI_SERVICE_RMS: Remote Management Service.
+ * @QMI_SERVICE_OMA: Open Mobile Alliance device management service.
+ *
+ * QMI services.
+ */
typedef enum {
/* Unknown service */
QMI_SERVICE_UNKNOWN = -1,
@@ -45,21 +70,21 @@ typedef enum {
/* Authentication service */
QMI_SERVICE_AUTH = 0x07,
/* AT service */
- QMI_SERVICE_AT = 0x08,
+ QMI_SERVICE_AT = 0x08,
/* Voice service */
QMI_SERVICE_VOICE = 0x09,
/* Card Application Toolkit service (major version 2) */
- QMI_SERVICE_CAT2 = 0x0A,
+ QMI_SERVICE_CAT2 = 0x0A,
/* User Identity Module service */
- QMI_SERVICE_UIM = 0x0B,
+ QMI_SERVICE_UIM = 0x0B,
/* Phonebook Management service */
- QMI_SERVICE_PBM = 0x0C,
+ QMI_SERVICE_PBM = 0x0C,
/* Location service (~ PDS major version 2) */
- QMI_SERVICE_LOC = 0x10,
+ QMI_SERVICE_LOC = 0x10,
/* No idea what this one means.. Search And Rescue? */
- QMI_SERVICE_SAR = 0x11,
+ QMI_SERVICE_SAR = 0x11,
/* Remote Filesystem service */
- QMI_SERVICE_RMTFS = 0x14,
+ QMI_SERVICE_RMTFS = 0x14,
/* Card Application Toolkit service */
QMI_SERVICE_CAT = 0xE0,
/* Remote Management Service */
@@ -71,12 +96,6 @@ typedef enum {
/*****************************************************************************/
/* QMI Control */
-typedef enum {
- QMI_CTL_FLAG_NONE = 0,
- QMI_CTL_FLAG_RESPONSE = 1 << 0,
- QMI_CTL_FLAG_INDICATION = 1 << 1
-} QmiCtlFlag;
-
/**
* QmiCtlDataFormat:
* @QMI_CTL_DATA_FORMAT_QOS_FLOW_HEADER_ABSENT: QoS header absent
@@ -90,7 +109,6 @@ typedef enum {
QMI_CTL_DATA_FORMAT_QOS_FLOW_HEADER_PRESENT = 1,
} QmiCtlDataFormat;
-
/**
* QmiCtlDataLinkProtocol:
* @QMI_CTL_DATA_LINK_PROTOCOL_802_3: data frames formatted as 802.3 Ethernet
@@ -104,9 +122,29 @@ typedef enum {
QMI_CTL_DATA_LINK_PROTOCOL_RAW_IP = 1 << 1,
} QmiCtlDataLinkProtocol;
-/*****************************************************************************/
-/* QMI Services */
+/**
+ * QmiCtlFlag:
+ * @QMI_CTL_FLAG_NONE: None.
+ * @QMI_CTL_FLAG_RESPONSE: Message is a response.
+ * @QMI_CTL_FLAG_INDICATION: Message is an indication.
+ *
+ * QMI flags in messages of the %QMI_SERVICE_CTL service.
+ */
+typedef enum {
+ QMI_CTL_FLAG_NONE = 0,
+ QMI_CTL_FLAG_RESPONSE = 1 << 0,
+ QMI_CTL_FLAG_INDICATION = 1 << 1
+} QmiCtlFlag;
+/**
+ * QmiServiceFlag:
+ * @QMI_SERVICE_FLAG_NONE: None.
+ * @QMI_SERVICE_FLAG_COMPOUND: Message is compound.
+ * @QMI_SERVICE_FLAG_RESPONSE: Message is a response.
+ * @QMI_SERVICE_FLAG_INDICATION: Message is an indication.
+ *
+ * QMI flags in messages which are not of the %QMI_SERVICE_CTL service.
+ */
typedef enum {
QMI_SERVICE_FLAG_NONE = 0,
QMI_SERVICE_FLAG_COMPOUND = 1 << 0,