diff options
author | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-08 13:17:01 +0200 |
---|---|---|
committer | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-09 12:20:55 +0200 |
commit | 75ccb48f4d0e9f2e29a4689ca8cce14b0ee7272e (patch) | |
tree | 55060c318c87683fffb02970a84c6e203468d2d1 /libqmi-glib | |
parent | b0b1fe322114380e0928ba6d9b499c7a22b16144 (diff) |
libmm-glib: fix multiple documentation issues
Diffstat (limited to 'libqmi-glib')
-rw-r--r-- | libqmi-glib/qmi-client.c | 17 | ||||
-rw-r--r-- | libqmi-glib/qmi-client.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-device.c | 35 | ||||
-rw-r--r-- | libqmi-glib/qmi-device.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-dms.h | 2 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-nas.h | 72 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-wds.h | 6 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-wms.h | 2 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums.h | 70 | ||||
-rw-r--r-- | libqmi-glib/qmi-errors.h | 4 | ||||
-rw-r--r-- | libqmi-glib/qmi-flags64-nas.h | 4 | ||||
-rw-r--r-- | libqmi-glib/qmi-message.c | 13 |
12 files changed, 159 insertions, 82 deletions
diff --git a/libqmi-glib/qmi-client.c b/libqmi-glib/qmi-client.c index 456521a..aec7299 100644 --- a/libqmi-glib/qmi-client.c +++ b/libqmi-glib/qmi-client.c @@ -28,6 +28,19 @@ #include "qmi-client.h" #include "qmi-ctl.h" +/** + * SECTION:qmi-client + * @title: QmiClient + * @short_description: Generic QMI client handling routines + * + * #QmiClient is a generic type representing a QMI client for any kind of + * #QmiService. + * + * These objects are created by a #QmiDevice with qmi_device_allocate_client(), + * and before completely disposing them qmi_device_release_client() needs to be + * called in order to release the unique client ID reserved. + */ + G_DEFINE_ABSTRACT_TYPE (QmiClient, qmi_client, G_TYPE_OBJECT); enum { @@ -133,7 +146,7 @@ qmi_client_get_cid (QmiClient *self) * * Get the version of the service handled by this #QmiClient. * - * Returns: #TRUE if the version was properly reported, #FALSE otherwise. + * Returns: %TRUE if the version was properly reported, %FALSE otherwise. */ gboolean qmi_client_get_version (QmiClient *self, @@ -161,7 +174,7 @@ qmi_client_get_version (QmiClient *self, * Checks if the version of the service handled by this #QmiClient is greater * or equal than the given version. * - * Returns: #TRUE if the version of the service is greater or equal than the one given, #FALSE otherwise. + * Returns: %TRUE if the version of the service is greater or equal than the one given, %FALSE otherwise. */ gboolean qmi_client_check_version (QmiClient *self, diff --git a/libqmi-glib/qmi-client.h b/libqmi-glib/qmi-client.h index 4f7a618..d9c5991 100644 --- a/libqmi-glib/qmi-client.h +++ b/libqmi-glib/qmi-client.h @@ -50,12 +50,20 @@ typedef struct _QmiClientPrivate QmiClientPrivate; #define QMI_CLIENT_VERSION_MAJOR "client-version-major" #define QMI_CLIENT_VERSION_MINOR "client-version-minor" +/** + * QmiClient: + * + * The #QmiClient structure contains private data and should only be accessed + * using the provided API. + */ struct _QmiClient { + /*< private >*/ GObject parent; QmiClientPrivate *priv; }; struct _QmiClientClass { + /*< private >*/ GObjectClass parent; /* Virtual method to get indications processed */ diff --git a/libqmi-glib/qmi-device.c b/libqmi-glib/qmi-device.c index 8625d99..549296c 100644 --- a/libqmi-glib/qmi-device.c +++ b/libqmi-glib/qmi-device.c @@ -39,6 +39,17 @@ #include "qmi-error-types.h" #include "qmi-enum-types.h" +/** + * SECTION:qmi-device + * @title: QmiDevice + * @short_description: Generic QMI device handling routines + * + * #QmiDevice is a generic type in charge of controlling the access of multiple + * #QmiClient objects to the managed QMI port. + * + * A #QmiDevice can only handle one single QMI port. + */ + static void async_initable_iface_init (GAsyncInitableIface *iface); G_DEFINE_TYPE_EXTENDED (QmiDevice, qmi_device, G_TYPE_OBJECT, 0, @@ -416,7 +427,7 @@ qmi_device_get_path_display (QmiDevice *self) * * Checks whether the #QmiDevice is open for I/O. * - * Returns: #TRUE if @self is open, #FALSE otherwise. + * Returns: %TRUE if @self is open, %FALSE otherwise. */ gboolean qmi_device_is_open (QmiDevice *self) @@ -496,7 +507,7 @@ allocate_client_context_complete_and_free (AllocateClientContext *ctx) * qmi_device_allocate_client_finish: * @self: a #QmiDevice. * @res: a #GAsyncResult. - * @error: a #GError. + * @error: Return location for error or %NULL. * * Finishes an operation started with qmi_device_allocate_client(). * @@ -764,14 +775,14 @@ release_client_context_complete_and_free (ReleaseClientContext *ctx) * qmi_device_release_client_finish: * @self: a #QmiDevice. * @res: a #GAsyncResult. - * @error: a #GError. + * @error: Return location for error or %NULL. * * Finishes an operation started with qmi_device_release_client(). * * Note that even if the release operation returns an error, the client should * anyway be considered released, and shouldn't be used afterwards. * - * Returns: #TRUE if successful, or #NULL if @error is set. + * Returns: %TRUE if successful, or #NULL if @error is set. */ gboolean qmi_device_release_client_finish (QmiDevice *self, @@ -922,11 +933,11 @@ qmi_device_release_client (QmiDevice *self, * @self: a #QmiDevice. * @res: a #GAsyncResult. * @link_id: a placeholder for the output #guint16, or #NULL if not required. - * @error: a #GError. + * @error: Return location for error or %NULL. * * Finishes an operation started with qmi_device_set_instance_id(). * - * Returns: #TRUE if successful, #FALSE if @error is set. + * Returns: %TRUE if successful, %FALSE if @error is set. */ gboolean qmi_device_set_instance_id_finish (QmiDevice *self, @@ -1303,11 +1314,11 @@ device_open_context_complete_and_free (DeviceOpenContext *ctx) * qmi_device_open_finish: * @self: a #QmiDevice. * @res: a #GAsyncResult. - * @error: a #GError. + * @error: Return location for error or %NULL. * - * Finishes an asynchronous open operation started with qmi_device_open_async(). + * Finishes an asynchronous open operation started with qmi_device_open(). * - * Returns: #TRUE if successful, #FALSE if @error is set. + * Returns: %TRUE if successful, %FALSE if @error is set. */ gboolean qmi_device_open_finish (QmiDevice *self, @@ -1638,13 +1649,13 @@ destroy_iochannel (QmiDevice *self, /** * qmi_device_close: * @self: a #QmiDevice - * @error: a #GError + * @error: Return location for error or %NULL. * * Synchronously closes a #QmiDevice, preventing any further I/O. * * Closing a #QmiDevice multiple times will not return an error. * - * Returns: #TRUE if successful, #FALSE if @error is set. + * Returns: %TRUE if successful, %FALSE if @error is set. */ gboolean qmi_device_close (QmiDevice *self, @@ -1794,7 +1805,7 @@ qmi_device_command (QmiDevice *self, /** * qmi_device_new_finish: * @res: a #GAsyncResult. - * @error: a #GError. + * @error: Return location for error or %NULL. * * Finishes an operation started with qmi_device_new(). * diff --git a/libqmi-glib/qmi-device.h b/libqmi-glib/qmi-device.h index 694b47a..37e14e3 100644 --- a/libqmi-glib/qmi-device.h +++ b/libqmi-glib/qmi-device.h @@ -46,12 +46,20 @@ typedef struct _QmiDevicePrivate QmiDevicePrivate; #define QMI_DEVICE_FILE "device-file" #define QMI_DEVICE_CLIENT_CTL "device-client-ctl" +/** + * QmiDevice: + * + * The #QmiDevice structure contains private data and should only be accessed + * using the provided API. + */ struct _QmiDevice { + /*< private >*/ GObject parent; QmiDevicePrivate *priv; }; struct _QmiDeviceClass { + /*< private >*/ GObjectClass parent; }; diff --git a/libqmi-glib/qmi-enums-dms.h b/libqmi-glib/qmi-enums-dms.h index 980088d..1c96dfe 100644 --- a/libqmi-glib/qmi-enums-dms.h +++ b/libqmi-glib/qmi-enums-dms.h @@ -128,7 +128,7 @@ typedef enum { /* Helper enums for the 'QMI DMS UIM Get PIN Status' message */ /** - * QmiDmsPinStatus: + * QmiDmsUimPinStatus: * @QMI_DMS_UIM_PIN_STATUS_NOT_INITIALIZED: Not initialized. * @QMI_DMS_UIM_PIN_STATUS_ENABLED_NOT_VERIFIED: Enabled, not verified. * @QMI_DMS_UIM_PIN_STATUS_ENABLED_VERIFIED: Enabled, verified. diff --git a/libqmi-glib/qmi-enums-nas.h b/libqmi-glib/qmi-enums-nas.h index 729743e..73a50bb 100644 --- a/libqmi-glib/qmi-enums-nas.h +++ b/libqmi-glib/qmi-enums-nas.h @@ -81,8 +81,8 @@ typedef enum { * @QMI_NAS_ACTIVE_BAND_GSM_900_EXTENDED: GSM 900 (Extended). * @QMI_NAS_ACTIVE_BAND_GSM_900_PRIMARY: GSM 900 (Primary). * @QMI_NAS_ACTIVE_BAND_GSM_900_RAILWAYS: GSM 900 (Railways). - * @QMI_NAS_ACTIVE_BAND_GSM_1800: GSM 1800. - * @QMI_NAS_ACTIVE_BAND_GSM_1900: GSM 1900. + * @QMI_NAS_ACTIVE_BAND_GSM_DCS_1800: GSM 1800. + * @QMI_NAS_ACTIVE_BAND_GSM_PCS_1900: GSM 1900. * @QMI_NAS_ACTIVE_BAND_WCDMA_2100: WCDMA 2100. * @QMI_NAS_ACTIVE_BAND_WCDMA_PCS_1900: WCDMA PCS 1900. * @QMI_NAS_ACTIVE_BAND_WCDMA_DCS_1800: WCDMA DCS 1800. @@ -94,38 +94,38 @@ typedef enum { * @QMI_NAS_ACTIVE_BAND_WCDMA_1700_JAPAN: WCDMA 1700 (Japan). * @QMI_NAS_ACTIVE_BAND_WCDMA_1500_JAPAN: WCDMA 1500 (Japan). * @QMI_NAS_ACTIVE_BAND_WCDMA_850_JAPAN: WCDMA 850 (Japan). - * @QMI_NAS_ACTIVE_BAND_EUTRA_1: E-UTRA band 1. - * @QMI_NAS_ACTIVE_BAND_EUTRA_2: E-UTRA band 2. - * @QMI_NAS_ACTIVE_BAND_EUTRA_3: E-UTRA band 3. - * @QMI_NAS_ACTIVE_BAND_EUTRA_4: E-UTRA band 4. - * @QMI_NAS_ACTIVE_BAND_EUTRA_5: E-UTRA band 5. - * @QMI_NAS_ACTIVE_BAND_EUTRA_6: E-UTRA band 6. - * @QMI_NAS_ACTIVE_BAND_EUTRA_7: E-UTRA band 7. - * @QMI_NAS_ACTIVE_BAND_EUTRA_8: E-UTRA band 8. - * @QMI_NAS_ACTIVE_BAND_EUTRA_9: E-UTRA band 9. - * @QMI_NAS_ACTIVE_BAND_EUTRA_10: E-UTRA band 10. - * @QMI_NAS_ACTIVE_BAND_EUTRA_11: E-UTRA band 11. - * @QMI_NAS_ACTIVE_BAND_EUTRA_12: E-UTRA band 12. - * @QMI_NAS_ACTIVE_BAND_EUTRA_13: E-UTRA band 13. - * @QMI_NAS_ACTIVE_BAND_EUTRA_14: E-UTRA band 14. - * @QMI_NAS_ACTIVE_BAND_EUTRA_17: E-UTRA band 17. - * @QMI_NAS_ACTIVE_BAND_EUTRA_18: E-UTRA band 18. - * @QMI_NAS_ACTIVE_BAND_EUTRA_19: E-UTRA band 19. - * @QMI_NAS_ACTIVE_BAND_EUTRA_20: E-UTRA band 20. - * @QMI_NAS_ACTIVE_BAND_EUTRA_21: E-UTRA band 21. - * @QMI_NAS_ACTIVE_BAND_EUTRA_24: E-UTRA band 24. - * @QMI_NAS_ACTIVE_BAND_EUTRA_25: E-UTRA band 25. - * @QMI_NAS_ACTIVE_BAND_EUTRA_33: E-UTRA band 33. - * @QMI_NAS_ACTIVE_BAND_EUTRA_34: E-UTRA band 34. - * @QMI_NAS_ACTIVE_BAND_EUTRA_35: E-UTRA band 35. - * @QMI_NAS_ACTIVE_BAND_EUTRA_36: E-UTRA band 36. - * @QMI_NAS_ACTIVE_BAND_EUTRA_37: E-UTRA band 37. - * @QMI_NAS_ACTIVE_BAND_EUTRA_38: E-UTRA band 38. - * @QMI_NAS_ACTIVE_BAND_EUTRA_39: E-UTRA band 39. - * @QMI_NAS_ACTIVE_BAND_EUTRA_40: E-UTRA band 40. - * @QMI_NAS_ACTIVE_BAND_EUTRA_41: E-UTRA band 41. - * @QMI_NAS_ACTIVE_BAND_EUTRA_42: E-UTRA band 42. - * @QMI_NAS_ACTIVE_BAND_EUTRA_43: E-UTRA band 43. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_1: EUTRAN band 1. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_2: EUTRAN band 2. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_3: EUTRAN band 3. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_4: EUTRAN band 4. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_5: EUTRAN band 5. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_6: EUTRAN band 6. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_7: EUTRAN band 7. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_8: EUTRAN band 8. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_9: EUTRAN band 9. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_10: EUTRAN band 10. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_11: EUTRAN band 11. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_12: EUTRAN band 12. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_13: EUTRAN band 13. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_14: EUTRAN band 14. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_17: EUTRAN band 17. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_18: EUTRAN band 18. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_19: EUTRAN band 19. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_20: EUTRAN band 20. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_21: EUTRAN band 21. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_24: EUTRAN band 24. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_25: EUTRAN band 25. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_33: EUTRAN band 33. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_34: EUTRAN band 34. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_35: EUTRAN band 35. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_36: EUTRAN band 36. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_37: EUTRAN band 37. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_38: EUTRAN band 38. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_39: EUTRAN band 39. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_40: EUTRAN band 40. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_41: EUTRAN band 41. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_42: EUTRAN band 42. + * @QMI_NAS_ACTIVE_BAND_EUTRAN_43: EUTRAN band 43. * @QMI_NAS_ACTIVE_BAND_TDSCDMA_A: TD-SCDMA Band A. * @QMI_NAS_ACTIVE_BAND_TDSCDMA_B: TD-SCDMA Band B. * @QMI_NAS_ACTIVE_BAND_TDSCDMA_C: TD-SCDMA Band C. @@ -629,8 +629,8 @@ typedef enum { /** * QmiNasNetworkSelectionPreference: - * @QMI_NAS_NETWORK_SELECTION_PREFERENCE_AUTOMATIC: - * @QMI_NAS_NETWORK_SELECTION_PREFERENCE_MANUAL: + * @QMI_NAS_NETWORK_SELECTION_PREFERENCE_AUTOMATIC: Automatic. + * @QMI_NAS_NETWORK_SELECTION_PREFERENCE_MANUAL: Manual. * * Network selection preference. */ diff --git a/libqmi-glib/qmi-enums-wds.h b/libqmi-glib/qmi-enums-wds.h index a5e8129..335e36a 100644 --- a/libqmi-glib/qmi-enums-wds.h +++ b/libqmi-glib/qmi-enums-wds.h @@ -597,7 +597,7 @@ typedef enum { * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_TIMEOUT: (VSNCP) timeout. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_FAILURE: (VSNCP) failure. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_GENERAL_ERROR: (VSCNP) 3GPP2 general error. - * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_UNAUTHENTICATED_APN: : (VSCNP) 3GPP2 unauthenticated APN. + * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_UNAUTHENTICATED_APN: (VSCNP) 3GPP2 unauthenticated APN. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_PDN_LIMIT_EXCEEDED: (VSCNP) 3GPP2 PDN limit exceeded. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_NO_PDN_GATEWAY: (VSCNP) 3GPP2 no PDN gateway. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_PDN_GATEWAY_UNREACHABLE: (VSCNP) 3GPP2 PDN gateway unreachable. @@ -605,7 +605,7 @@ typedef enum { * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_INSUFFICIENT_PARAMETERS: (VSCNP) 3GPP2 insufficient parameters. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_RESOURCE_UNAVAILABLE: (VSCNP) 3GPP2 resource unavailable. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_ADMINISTRATIVELY_PROHIBITED: (VSCNP) 3GPP2 administratively prohibited. - * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_PDN_ID_IN_USE: : (VSCNP) 3GPP2 PDN ID in use. + * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_PDN_ID_IN_USE: (VSCNP) 3GPP2 PDN ID in use. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_SUBSCRIPTION_LIMITATION: (VSCNP) 3GPP2 subscription limitation. * @QMI_WDS_VERBOSE_CALL_END_REASON_EHRPD_VSNCP_3GPP2_PDN_EXISTS_FOR_THIS_APN: (VSCNP) 3GPP2 PDN exists for this APN. * @@ -728,7 +728,7 @@ typedef enum { /** * QmiWdsRat3gpp2: - * @QMI_WDS_RAT_3GPP2_UNKNOWN: Unknown, to be ignored. + * @QMI_WDS_RAT_3GPP2_NONE: Unknown, to be ignored. * @QMI_WDS_RAT_3GPP2_CDMA1X: CDMA 1x. * @QMI_WDS_RAT_3GPP2_EVDO_REV0: EVDO Rev0. * @QMI_WDS_RAT_3GPP2_EVDO_REVA: EVDO RevA. diff --git a/libqmi-glib/qmi-enums-wms.h b/libqmi-glib/qmi-enums-wms.h index 6ab1570..9248746 100644 --- a/libqmi-glib/qmi-enums-wms.h +++ b/libqmi-glib/qmi-enums-wms.h @@ -295,7 +295,7 @@ typedef enum { QMI_WMS_GSM_UMTS_TP_CAUSE_TPDU_NOT_SUPPORTED = 0xB0, QMI_WMS_GSM_UMTS_TP_CAUSE_SC_BUSY = 0xC0, QMI_WMS_GSM_UMTS_TP_CAUSE_NO_SC_SUBSCRIPTION = 0xC1, - QMI_WMS_GSM_UMTS_TP_CAUSE_SC_SYS_FAILURE = 0xC2, + QMI_WMS_GSM_UMTS_TP_CAUSE_SC_SYSTEM_FAILURE = 0xC2, QMI_WMS_GSM_UMTS_TP_CAUSE_INVALID_SME_ADDRESS = 0xC3, QMI_WMS_GSM_UMTS_TP_CAUSE_DESTINATION_SME_BARRED = 0xC4, QMI_WMS_GSM_UMTS_TP_CAUSE_SM_REJECTED_OR_DUPLICATE = 0xC5, 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, diff --git a/libqmi-glib/qmi-errors.h b/libqmi-glib/qmi-errors.h index 71f72b0..5ee3fc0 100644 --- a/libqmi-glib/qmi-errors.h +++ b/libqmi-glib/qmi-errors.h @@ -76,7 +76,7 @@ typedef enum { /*< underscore_name=qmi_core_error >*/ * @QMI_PROTOCOL_ERROR_INVALID_TRANSACTION_ID: Invalid transaction ID. * @QMI_PROTOCOL_ERROR_DEVICE_IN_USE: Device in use. * @QMI_PROTOCOL_ERROR_NETWORK_UNSUPPORTED: Network unsupported. - * @QMI_PROTOCOL_ERROR_DEVICE_UNSUPPORTED Device unsupported. + * @QMI_PROTOCOL_ERROR_DEVICE_UNSUPPORTED: Device unsupported. * @QMI_PROTOCOL_ERROR_NO_EFFECT: No effect. * @QMI_PROTOCOL_ERROR_NO_FREE_PROFILE: No free profile. * @QMI_PROTOCOL_ERROR_INVALID_PDP_TYPE: Invalid PDP type. @@ -117,7 +117,7 @@ typedef enum { /*< underscore_name=qmi_core_error >*/ * @QMI_PROTOCOL_ERROR_DISABLED: Disabled. * @QMI_PROTOCOL_ERROR_INVALID_OPERATION: Invalid operation. * @QMI_PROTOCOL_ERROR_INVALID_QMI_COMMAND: Invalid QMI command. - * @QMI_PROTOCOL_ERROR_WMS_TPDU_TYPE: WMS TPDU type. + * @QMI_PROTOCOL_ERROR_WMS_T_PDU_TYPE: WMS T-PDU type. * @QMI_PROTOCOL_ERROR_WMS_SMSC_ADDRESS: WMS SMSC address. * @QMI_PROTOCOL_ERROR_INFORMATION_UNAVAILABLE: Information unavailable. * @QMI_PROTOCOL_ERROR_SEGMENT_TOO_LONG: Segment too long. diff --git a/libqmi-glib/qmi-flags64-nas.h b/libqmi-glib/qmi-flags64-nas.h index 252f7c9..9897aa7 100644 --- a/libqmi-glib/qmi-flags64-nas.h +++ b/libqmi-glib/qmi-flags64-nas.h @@ -30,7 +30,7 @@ /** * QmiNasBandPreference: * @QMI_NAS_BAND_PREFERENCE_BC_0_A_SYSTEM: Band class 0, A system. - * @QMI_NAS_BAND_PREFERENCE_BC_0_B: Band class 0, B system. + * @QMI_NAS_BAND_PREFERENCE_BC_0_B_SYSTEM: Band class 0, B system. * @QMI_NAS_BAND_PREFERENCE_BC_1_ALL_BLOCKS: Band class 1. * @QMI_NAS_BAND_PREFERENCE_BC_2: Band class 2. * @QMI_NAS_BAND_PREFERENCE_BC_3_A_SYSTEM: Band class 3, A system. @@ -57,7 +57,7 @@ * @QMI_NAS_BAND_PREFERENCE_GSM_750: GSM 750. * @QMI_NAS_BAND_PREFERENCE_GSM_850: GSM 850. * @QMI_NAS_BAND_PREFERENCE_GSM_900_RAILWAYS: GSM 900 (Railways). - * @QMI_NAS_BAND_PREFERENCE_GSM_1900: GSM 1900. + * @QMI_NAS_BAND_PREFERENCE_GSM_PCS_1900: GSM 1900. * @QMI_NAS_BAND_PREFERENCE_WCDMA_2100: WCDMA 2100. * @QMI_NAS_BAND_PREFERENCE_WCDMA_PCS_1900: WCDMA PCS 1900. * @QMI_NAS_BAND_PREFERENCE_WCDMA_DCS_1800: WCDMA DCS 1800. diff --git a/libqmi-glib/qmi-message.c b/libqmi-glib/qmi-message.c index fe9f094..267030c 100644 --- a/libqmi-glib/qmi-message.c +++ b/libqmi-glib/qmi-message.c @@ -145,7 +145,7 @@ get_qmi_flags (QmiMessage *self) * * Checks whether the given #QmiMessage is a response. * - * Returns: #TRUE if @self is a response message, #FALSE otherwise. + * Returns: %TRUE if @self is a response message, %FALSE otherwise. */ gboolean qmi_message_is_response (QmiMessage *self) @@ -167,7 +167,7 @@ qmi_message_is_response (QmiMessage *self) * * Checks whether the given #QmiMessage is an indication. * - * Returns: #TRUE if @self is an indication message, #FALSE otherwise. + * Returns: %TRUE if @self is an indication message, %FALSE otherwise. */ gboolean qmi_message_is_indication (QmiMessage *self) @@ -341,7 +341,7 @@ qmi_tlv_next (QmiMessage *self, * field are all consistent. * 3. The TLVs in the message fit exactly in the payload size. * - * Returns: #TRUE if the message is valid, #FALSE otherwise. + * Returns: %TRUE if the message is valid, %FALSE otherwise. */ static gboolean message_check (QmiMessage *self, @@ -529,7 +529,7 @@ qmi_message_unref (QmiMessage *self) /** * qmi_message_get_raw: * @self: a #QmiMessage. - * @len: (out): return location for the size of the output buffer. + * @length: (out): return location for the size of the output buffer. * @error: return location for error or %NULL. * * Gets the raw data buffer of the #QmiMessage. @@ -553,7 +553,6 @@ qmi_message_get_raw (QmiMessage *self, * @self: a #QmiMessage. * @type: specific ID of the TLV to get. * @length: (out): return location for the length of the TLV. - * @error: return location for error or %NULL. * * Get the raw data buffer of a specific TLV within the #QmiMessage. * @@ -615,7 +614,7 @@ qmi_message_foreach_raw_tlv (QmiMessage *self, * * Creates a new @type TLV with the value given in @raw, and adds it to the #QmiMessage. * - * Returns: #TRUE if the TLV as successfully added, otherwise #FALSE is returned and @error is set. + * Returns: %TRUE if the TLV as successfully added, otherwise %FALSE is returned and @error is set. */ gboolean qmi_message_add_raw_tlv (QmiMessage *self, @@ -875,7 +874,7 @@ qmi_message_get_printable (QmiMessage *self, * * Gets, if known, the service version in which the given message was first introduced. * - * Returns: #TRUE if @major and @minor are set, #FALSE otherwise. + * Returns: %TRUE if @major and @minor are set, %FALSE otherwise. */ gboolean qmi_message_get_version_introduced (QmiMessage *self, |