diff options
author | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-09 11:57:41 +0200 |
---|---|---|
committer | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-09 15:23:48 +0200 |
commit | 3bbdc479476a401398b1b62dac9a881bfc636feb (patch) | |
tree | 4ddf7bc0d7e92b4806eaad091fd6f5a32eb0144e | |
parent | a873852f8e0e4f248e0b7bb9acf6ab232bfcf644 (diff) | |
download | external_libqmi-3bbdc479476a401398b1b62dac9a881bfc636feb.zip external_libqmi-3bbdc479476a401398b1b62dac9a881bfc636feb.tar.gz external_libqmi-3bbdc479476a401398b1b62dac9a881bfc636feb.tar.bz2 |
docs: improve documentation of enums, flags and errors
-rw-r--r-- | build-aux/templates/qmi-enum-types-template.c | 31 | ||||
-rw-r--r-- | build-aux/templates/qmi-enum-types-template.h | 10 | ||||
-rw-r--r-- | build-aux/templates/qmi-flags64-types-template.c | 9 | ||||
-rw-r--r-- | docs/reference/libqmi-glib/libqmi-glib-common.sections | 731 | ||||
-rw-r--r-- | docs/reference/libqmi-glib/libqmi-glib-docs.xml | 5 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-dms.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-nas.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-pds.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-wds.h | 9 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-wms.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums.h | 7 | ||||
-rw-r--r-- | libqmi-glib/qmi-errors.h | 7 |
12 files changed, 456 insertions, 385 deletions
diff --git a/build-aux/templates/qmi-enum-types-template.c b/build-aux/templates/qmi-enum-types-template.c index 7f12c2c..db29eec 100644 --- a/build-aux/templates/qmi-enum-types-template.c +++ b/build-aux/templates/qmi-enum-types-template.c @@ -17,9 +17,9 @@ static const G@Type@Value @enum_name@_values[] = { }; /* Define type-specific symbols */ -#undef IS_ENUM -#undef IS_FLAGS -#define IS_@TYPE@ +#undef __QMI_IS_ENUM__ +#undef __QMI_IS_FLAGS__ +#define __QMI_IS_@TYPE@__ GType @enum_name@_get_type (void) @@ -39,7 +39,15 @@ GType /* Enum-specific method to get the value as a string. * We get the nick of the GEnumValue. Note that this will be * valid even if the GEnumClass is not referenced anywhere. */ -#if defined IS_ENUM +#if defined __QMI_IS_ENUM__ +/** + * @enum_name@_get_string: + * @val: a @EnumName@. + * + * Gets the nickname string for the #@EnumName@ specified at @val. + * + * Returns: (transfer none): a string with the nickname, or %NULL if not found. Do not free the returned value. + */ const gchar * @enum_name@_get_string (@EnumName@ val) { @@ -52,13 +60,22 @@ const gchar * return NULL; } -#endif /* IS_ENUM */ +#endif /* __QMI_IS_ENUM__ */ /* Flags-specific method to build a string with the given mask. * We get a comma separated list of the nicks of the GFlagsValues. * Note that this will be valid even if the GFlagsClass is not referenced * anywhere. */ -#if defined IS_FLAGS +#if defined __QMI_IS_FLAGS__ +/** + * @enum_name@_build_string_from_mask: + * @mask: bitmask of @EnumName@ values. + * + * Builds a string containing a comma-separated list of nicknames for + * each #@EnumName@ in @mask. + * + * Returns: (transfer full): a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + */ gchar * @enum_name@_build_string_from_mask (@EnumName@ mask) { @@ -96,7 +113,7 @@ gchar * return (str ? g_string_free (str, FALSE) : NULL); } -#endif /* IS_FLAGS */ +#endif /* __QMI_IS_FLAGS__ */ /*** END value-tail ***/ diff --git a/build-aux/templates/qmi-enum-types-template.h b/build-aux/templates/qmi-enum-types-template.h index 13db2a6..bdcd4e7 100644 --- a/build-aux/templates/qmi-enum-types-template.h +++ b/build-aux/templates/qmi-enum-types-template.h @@ -15,15 +15,15 @@ GType @enum_name@_get_type (void) G_GNUC_CONST; #define @ENUMPREFIX@_TYPE_@ENUMSHORT@ (@enum_name@_get_type ()) /* Define type-specific symbols */ -#undef IS_ENUM -#undef IS_FLAGS -#define IS_@TYPE@ +#undef __QMI_IS_ENUM__ +#undef __QMI_IS_FLAGS_ +#define __QMI_IS_@TYPE@__ -#if defined IS_ENUM +#if defined __QMI_IS_ENUM__ const gchar *@enum_name@_get_string (@EnumName@ val); #endif -#if defined IS_FLAGS +#if defined __QMI_IS_FLAGS__ gchar *@enum_name@_build_string_from_mask (@EnumName@ mask); #endif diff --git a/build-aux/templates/qmi-flags64-types-template.c b/build-aux/templates/qmi-flags64-types-template.c index e8feb96..c1c5491 100644 --- a/build-aux/templates/qmi-flags64-types-template.c +++ b/build-aux/templates/qmi-flags64-types-template.c @@ -22,6 +22,15 @@ static const GFlags64Value @enum_name@_values[] = { { 0, NULL, NULL } }; +/** + * @enum_name@_build_string_from_mask: + * @mask: bitmask of @EnumName@ values. + * + * Builds a string containing a comma-separated list of nicknames for + * each #@EnumName@ in @mask. + * + * Returns: (transfer full): a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + */ gchar * @enum_name@_build_string_from_mask (@EnumName@ mask) { diff --git a/docs/reference/libqmi-glib/libqmi-glib-common.sections b/docs/reference/libqmi-glib/libqmi-glib-common.sections index e732215..80edb76 100644 --- a/docs/reference/libqmi-glib/libqmi-glib-common.sections +++ b/docs/reference/libqmi-glib/libqmi-glib-common.sections @@ -67,215 +67,211 @@ qmi_device_get_type </SECTION> <SECTION> -<FILE>qmi-enum-types</FILE> -IS_ENUM +<FILE>qmi-enums</FILE> +QmiService +<SUBSECTION Methods> qmi_service_get_string +<SUBSECTION Private> qmi_service_build_string_from_mask -IS_FLAGS -qmi_wds_ip_family_get_string -qmi_wds_ip_family_build_string_from_mask -qmi_wds_technology_preference_get_string -qmi_wds_technology_preference_build_string_from_mask -qmi_wds_extended_technology_preference_get_string -qmi_wds_extended_technology_preference_build_string_from_mask -qmi_wds_call_type_get_string -qmi_wds_call_type_build_string_from_mask -qmi_wds_call_end_reason_get_string -qmi_wds_call_end_reason_build_string_from_mask -qmi_wds_verbose_call_end_reason_type_get_string -qmi_wds_verbose_call_end_reason_type_build_string_from_mask -qmi_wds_verbose_call_end_reason_mip_get_string -qmi_wds_verbose_call_end_reason_mip_build_string_from_mask -qmi_wds_verbose_call_end_reason_internal_get_string -qmi_wds_verbose_call_end_reason_internal_build_string_from_mask -qmi_wds_verbose_call_end_reason_cm_get_string -qmi_wds_verbose_call_end_reason_cm_build_string_from_mask -qmi_wds_verbose_call_end_reason_3gpp_get_string -qmi_wds_verbose_call_end_reason_3gpp_build_string_from_mask -qmi_wds_verbose_call_end_reason_ppp_get_string -qmi_wds_verbose_call_end_reason_ppp_build_string_from_mask -qmi_wds_verbose_call_end_reason_ehrpd_get_string -qmi_wds_verbose_call_end_reason_ehrpd_build_string_from_mask -qmi_wds_verbose_call_end_reason_ipv6_get_string -qmi_wds_verbose_call_end_reason_ipv6_build_string_from_mask -qmi_wds_connection_status_get_string -qmi_wds_connection_status_build_string_from_mask -qmi_wds_data_bearer_technology_get_string -qmi_wds_data_bearer_technology_build_string_from_mask -qmi_wds_network_type_get_string -qmi_wds_network_type_build_string_from_mask -qmi_wds_rat_3gpp2_get_string -qmi_wds_rat_3gpp2_build_string_from_mask -qmi_wds_rat_3gpp_get_string -qmi_wds_rat_3gpp_build_string_from_mask -qmi_wds_so_cdma1x_get_string -qmi_wds_so_cdma1x_build_string_from_mask -qmi_wds_so_evdo_reva_get_string -qmi_wds_so_evdo_reva_build_string_from_mask -qmi_wds_get_current_settings_requested_settings_get_string -qmi_wds_get_current_settings_requested_settings_build_string_from_mask -qmi_wds_pdp_type_get_string -qmi_wds_pdp_type_build_string_from_mask -qmi_wds_traffic_class_get_string -qmi_wds_traffic_class_build_string_from_mask -qmi_wds_authentication_get_string -qmi_wds_authentication_build_string_from_mask -qmi_wds_profile_type_get_string -qmi_wds_profile_type_build_string_from_mask +<SUBSECTION Standard> +QMI_TYPE_SERVICE +qmi_service_get_type +</SECTION> + +<SECTION> +<FILE>qmi-enums-dms</FILE> +QmiDmsDataServiceCapability +QmiDmsSimCapability +QmiDmsBandCapability +QmiDmsLteBandCapability +QmiDmsRadioInterface +QmiDmsPowerState +QmiDmsUimPinId +QmiDmsUimPinStatus +QmiDmsOperatingMode +QmiDmsOfflineReason +QmiDmsTimeSource +QmiDmsActivationState +QmiDmsUimFacility +QmiDmsUimFacilityState +QmiDmsUimState +QmiDmsTimeReferenceType +QmiDmsFirmwareImageType +<SUBSECTION Methods> qmi_dms_data_service_capability_get_string -qmi_dms_data_service_capability_build_string_from_mask qmi_dms_sim_capability_get_string -qmi_dms_sim_capability_build_string_from_mask +qmi_dms_band_capability_build_string_from_mask +qmi_dms_lte_band_capability_build_string_from_mask qmi_dms_radio_interface_get_string -qmi_dms_radio_interface_build_string_from_mask -qmi_dms_power_state_get_string qmi_dms_power_state_build_string_from_mask qmi_dms_uim_pin_id_get_string -qmi_dms_uim_pin_id_build_string_from_mask qmi_dms_uim_pin_status_get_string -qmi_dms_uim_pin_status_build_string_from_mask qmi_dms_operating_mode_get_string -qmi_dms_operating_mode_build_string_from_mask -qmi_dms_offline_reason_get_string qmi_dms_offline_reason_build_string_from_mask qmi_dms_time_source_get_string -qmi_dms_time_source_build_string_from_mask qmi_dms_activation_state_get_string -qmi_dms_activation_state_build_string_from_mask qmi_dms_uim_facility_get_string -qmi_dms_uim_facility_build_string_from_mask qmi_dms_uim_facility_state_get_string -qmi_dms_uim_facility_state_build_string_from_mask qmi_dms_uim_state_get_string -qmi_dms_uim_state_build_string_from_mask qmi_dms_time_reference_type_get_string -qmi_dms_time_reference_type_build_string_from_mask qmi_dms_firmware_image_type_get_string +<SUBSECTION Private> +qmi_dms_data_service_capability_build_string_from_mask +qmi_dms_sim_capability_build_string_from_mask +qmi_dms_radio_interface_build_string_from_mask +qmi_dms_power_state_get_string +qmi_dms_uim_pin_id_build_string_from_mask +qmi_dms_uim_pin_status_build_string_from_mask +qmi_dms_operating_mode_build_string_from_mask +qmi_dms_offline_reason_get_string +qmi_dms_time_source_build_string_from_mask +qmi_dms_activation_state_build_string_from_mask +qmi_dms_uim_facility_build_string_from_mask +qmi_dms_uim_facility_state_build_string_from_mask +qmi_dms_uim_state_build_string_from_mask +qmi_dms_time_reference_type_build_string_from_mask qmi_dms_firmware_image_type_build_string_from_mask +<SUBSECTION Standard> +QMI_TYPE_DMS_ACTIVATION_STATE +QMI_TYPE_DMS_DATA_SERVICE_CAPABILITY +QMI_TYPE_DMS_FIRMWARE_IMAGE_TYPE +QMI_TYPE_DMS_OFFLINE_REASON +QMI_TYPE_DMS_OPERATING_MODE +QMI_TYPE_DMS_POWER_STATE +QMI_TYPE_DMS_RADIO_INTERFACE +QMI_TYPE_DMS_SIM_CAPABILITY +QMI_TYPE_DMS_TIME_REFERENCE_TYPE +QMI_TYPE_DMS_TIME_SOURCE +QMI_TYPE_DMS_UIM_FACILITY +QMI_TYPE_DMS_UIM_FACILITY_STATE +QMI_TYPE_DMS_UIM_PIN_ID +QMI_TYPE_DMS_UIM_PIN_STATUS +QMI_TYPE_DMS_UIM_STATE +qmi_dms_activation_state_get_type +qmi_dms_data_service_capability_get_type +qmi_dms_firmware_image_type_get_type +qmi_dms_offline_reason_get_type +qmi_dms_operating_mode_get_type +qmi_dms_power_state_get_type +qmi_dms_radio_interface_get_type +qmi_dms_sim_capability_get_type +qmi_dms_time_reference_type_get_type +qmi_dms_time_source_get_type +qmi_dms_uim_facility_get_type +qmi_dms_uim_facility_state_get_type +qmi_dms_uim_pin_id_get_type +qmi_dms_uim_pin_status_get_type +qmi_dms_uim_state_get_type +</SECTION> + +<SECTION> +<FILE>qmi-enums-nas</FILE> +QmiNasRadioInterface +QmiNasActiveBand +QmiNasNetworkServiceDomain +QmiNasEvdoSinrLevel +QmiNasSignalStrengthRequest +QmiNasNetworkScanType +QmiNasNetworkStatus +QmiNasNetworkRegisterType +QmiNasRegistrationState +QmiNasAttachState +QmiNasNetworkType +QmiNasRoamingIndicatorStatus +QmiNasDataCapability +QmiNasServiceStatus +QmiNasHdrPersonality +QmiNasCallBarringStatus +QmiNasNetworkDescriptionDisplay +QmiNasNetworkDescriptionEncoding +QmiNasRadioTechnologyPreference +QmiNasPreferenceDuration +QmiNasRatModePreference +QmiNasCdmaPrlPreference +QmiNasRoamingPreference +QmiNasNetworkSelectionPreference +QmiNasChangeDuration +QmiNasServiceDomainPreference +QmiNasGsmWcdmaAcquisitionOrderPreference +QmiNasBandPreference +QmiNasLteBandPreference +QmiNasTdScdmaBandPreference +QmiNasRoamingStatus +QmiNasHdrProtocolRevision +QmiNasWcdmaHsService +QmiNasCellBroadcastCapability +QmiNasSimRejectState +<SUBSECTION Methods> qmi_nas_radio_interface_get_string -qmi_nas_radio_interface_build_string_from_mask qmi_nas_active_band_get_string -qmi_nas_active_band_build_string_from_mask qmi_nas_network_service_domain_get_string -qmi_nas_network_service_domain_build_string_from_mask qmi_nas_evdo_sinr_level_get_string -qmi_nas_evdo_sinr_level_build_string_from_mask -qmi_nas_signal_strength_request_get_string qmi_nas_signal_strength_request_build_string_from_mask -qmi_nas_network_scan_type_get_string qmi_nas_network_scan_type_build_string_from_mask -qmi_nas_network_status_get_string qmi_nas_network_status_build_string_from_mask qmi_nas_network_register_type_get_string -qmi_nas_network_register_type_build_string_from_mask qmi_nas_registration_state_get_string -qmi_nas_registration_state_build_string_from_mask qmi_nas_attach_state_get_string -qmi_nas_attach_state_build_string_from_mask qmi_nas_network_type_get_string -qmi_nas_network_type_build_string_from_mask qmi_nas_roaming_indicator_status_get_string -qmi_nas_roaming_indicator_status_build_string_from_mask qmi_nas_data_capability_get_string -qmi_nas_data_capability_build_string_from_mask qmi_nas_service_status_get_string -qmi_nas_service_status_build_string_from_mask qmi_nas_hdr_personality_get_string -qmi_nas_hdr_personality_build_string_from_mask qmi_nas_call_barring_status_get_string -qmi_nas_call_barring_status_build_string_from_mask qmi_nas_network_description_display_get_string -qmi_nas_network_description_display_build_string_from_mask qmi_nas_network_description_encoding_get_string -qmi_nas_network_description_encoding_build_string_from_mask -qmi_nas_radio_technology_preference_get_string qmi_nas_radio_technology_preference_build_string_from_mask qmi_nas_preference_duration_get_string -qmi_nas_preference_duration_build_string_from_mask -qmi_nas_rat_mode_preference_get_string qmi_nas_rat_mode_preference_build_string_from_mask qmi_nas_cdma_prl_preference_get_string -qmi_nas_cdma_prl_preference_build_string_from_mask qmi_nas_roaming_preference_get_string -qmi_nas_roaming_preference_build_string_from_mask qmi_nas_network_selection_preference_get_string -qmi_nas_network_selection_preference_build_string_from_mask qmi_nas_change_duration_get_string -qmi_nas_change_duration_build_string_from_mask qmi_nas_service_domain_preference_get_string -qmi_nas_service_domain_preference_build_string_from_mask qmi_nas_gsm_wcdma_acquisition_order_preference_get_string -qmi_nas_gsm_wcdma_acquisition_order_preference_build_string_from_mask -qmi_nas_td_scdma_band_preference_get_string +qmi_nas_band_preference_build_string_from_mask +qmi_nas_lte_band_preference_build_string_from_mask qmi_nas_td_scdma_band_preference_build_string_from_mask qmi_nas_roaming_status_get_string -qmi_nas_roaming_status_build_string_from_mask qmi_nas_hdr_protocol_revision_get_string -qmi_nas_hdr_protocol_revision_build_string_from_mask qmi_nas_wcdma_hs_service_get_string -qmi_nas_wcdma_hs_service_build_string_from_mask qmi_nas_cell_broadcast_capability_get_string -qmi_nas_cell_broadcast_capability_build_string_from_mask qmi_nas_sim_reject_state_get_string +<SUBSECTION Private> +qmi_nas_radio_interface_build_string_from_mask +qmi_nas_active_band_build_string_from_mask +qmi_nas_network_service_domain_build_string_from_mask +qmi_nas_evdo_sinr_level_build_string_from_mask +qmi_nas_signal_strength_request_get_string +qmi_nas_network_scan_type_get_string +qmi_nas_network_status_get_string +qmi_nas_network_register_type_build_string_from_mask +qmi_nas_registration_state_build_string_from_mask +qmi_nas_attach_state_build_string_from_mask +qmi_nas_network_type_build_string_from_mask +qmi_nas_roaming_indicator_status_build_string_from_mask +qmi_nas_data_capability_build_string_from_mask +qmi_nas_service_status_build_string_from_mask +qmi_nas_hdr_personality_build_string_from_mask +qmi_nas_call_barring_status_build_string_from_mask +qmi_nas_network_description_display_build_string_from_mask +qmi_nas_network_description_encoding_build_string_from_mask +qmi_nas_radio_technology_preference_get_string +qmi_nas_preference_duration_build_string_from_mask +qmi_nas_rat_mode_preference_get_string +qmi_nas_cdma_prl_preference_build_string_from_mask +qmi_nas_roaming_preference_build_string_from_mask +qmi_nas_network_selection_preference_build_string_from_mask +qmi_nas_change_duration_build_string_from_mask +qmi_nas_service_domain_preference_build_string_from_mask +qmi_nas_gsm_wcdma_acquisition_order_preference_build_string_from_mask +qmi_nas_td_scdma_band_preference_get_string +qmi_nas_roaming_status_build_string_from_mask +qmi_nas_hdr_protocol_revision_build_string_from_mask +qmi_nas_wcdma_hs_service_build_string_from_mask +qmi_nas_cell_broadcast_capability_build_string_from_mask qmi_nas_sim_reject_state_build_string_from_mask -qmi_wms_storage_type_get_string -qmi_wms_storage_type_build_string_from_mask -qmi_wms_ack_indicator_get_string -qmi_wms_ack_indicator_build_string_from_mask -qmi_wms_message_format_get_string -qmi_wms_message_format_build_string_from_mask -qmi_wms_message_mode_get_string -qmi_wms_message_mode_build_string_from_mask -qmi_wms_notification_type_get_string -qmi_wms_notification_type_build_string_from_mask -qmi_wms_cdma_service_option_get_string -qmi_wms_cdma_service_option_build_string_from_mask -qmi_wms_cdma_cause_code_get_string -qmi_wms_cdma_cause_code_build_string_from_mask -qmi_wms_cdma_error_class_get_string -qmi_wms_cdma_error_class_build_string_from_mask -qmi_wms_gsm_umts_rp_cause_get_string -qmi_wms_gsm_umts_rp_cause_build_string_from_mask -qmi_wms_gsm_umts_tp_cause_get_string -qmi_wms_gsm_umts_tp_cause_build_string_from_mask -qmi_wms_message_delivery_failure_type_get_string -qmi_wms_message_delivery_failure_type_build_string_from_mask -qmi_wms_message_tag_type_get_string -qmi_wms_message_tag_type_build_string_from_mask -qmi_wms_message_protocol_get_string -qmi_wms_message_protocol_build_string_from_mask -qmi_wms_message_type_get_string -qmi_wms_message_type_build_string_from_mask -qmi_wms_message_class_get_string -qmi_wms_message_class_build_string_from_mask -qmi_wms_receipt_action_get_string -qmi_wms_receipt_action_build_string_from_mask -qmi_wms_transfer_indication_get_string -qmi_wms_transfer_indication_build_string_from_mask -qmi_pds_operation_mode_get_string -qmi_pds_operation_mode_build_string_from_mask -qmi_pds_position_session_status_get_string -qmi_pds_position_session_status_build_string_from_mask -qmi_pds_data_valid_get_string -qmi_pds_data_valid_build_string_from_mask -qmi_pds_tracking_session_state_get_string -qmi_pds_tracking_session_state_build_string_from_mask <SUBSECTION Standard> -QMI_TYPE_DMS_ACTIVATION_STATE -QMI_TYPE_DMS_DATA_SERVICE_CAPABILITY -QMI_TYPE_DMS_FIRMWARE_IMAGE_TYPE -QMI_TYPE_DMS_OFFLINE_REASON -QMI_TYPE_DMS_OPERATING_MODE -QMI_TYPE_DMS_POWER_STATE -QMI_TYPE_DMS_RADIO_INTERFACE -QMI_TYPE_DMS_SIM_CAPABILITY -QMI_TYPE_DMS_TIME_REFERENCE_TYPE -QMI_TYPE_DMS_TIME_SOURCE -QMI_TYPE_DMS_UIM_FACILITY -QMI_TYPE_DMS_UIM_FACILITY_STATE -QMI_TYPE_DMS_UIM_PIN_ID -QMI_TYPE_DMS_UIM_PIN_STATUS -QMI_TYPE_DMS_UIM_STATE QMI_TYPE_NAS_ACTIVE_BAND QMI_TYPE_NAS_ATTACH_STATE QMI_TYPE_NAS_CALL_BARRING_STATUS @@ -309,68 +305,6 @@ QMI_TYPE_NAS_SIGNAL_STRENGTH_REQUEST QMI_TYPE_NAS_SIM_REJECT_STATE QMI_TYPE_NAS_TD_SCDMA_BAND_PREFERENCE QMI_TYPE_NAS_WCDMA_HS_SERVICE -QMI_TYPE_PDS_DATA_VALID -QMI_TYPE_PDS_OPERATION_MODE -QMI_TYPE_PDS_POSITION_SESSION_STATUS -QMI_TYPE_PDS_TRACKING_SESSION_STATE -QMI_TYPE_SERVICE -QMI_TYPE_WDS_AUTHENTICATION -QMI_TYPE_WDS_CALL_END_REASON -QMI_TYPE_WDS_CALL_TYPE -QMI_TYPE_WDS_CONNECTION_STATUS -QMI_TYPE_WDS_DATA_BEARER_TECHNOLOGY -QMI_TYPE_WDS_EXTENDED_TECHNOLOGY_PREFERENCE -QMI_TYPE_WDS_GET_CURRENT_SETTINGS_REQUESTED_SETTINGS -QMI_TYPE_WDS_IP_FAMILY -QMI_TYPE_WDS_NETWORK_TYPE -QMI_TYPE_WDS_PDP_TYPE -QMI_TYPE_WDS_PROFILE_TYPE -QMI_TYPE_WDS_RAT_3GPP -QMI_TYPE_WDS_RAT_3GPP2 -QMI_TYPE_WDS_SO_CDMA1X -QMI_TYPE_WDS_SO_EVDO_REVA -QMI_TYPE_WDS_TECHNOLOGY_PREFERENCE -QMI_TYPE_WDS_TRAFFIC_CLASS -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_3GPP -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_CM -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_EHRPD -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_INTERNAL -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_IPV6 -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_MIP -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_PPP -QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_TYPE -QMI_TYPE_WMS_ACK_INDICATOR -QMI_TYPE_WMS_CDMA_CAUSE_CODE -QMI_TYPE_WMS_CDMA_ERROR_CLASS -QMI_TYPE_WMS_CDMA_SERVICE_OPTION -QMI_TYPE_WMS_GSM_UMTS_RP_CAUSE -QMI_TYPE_WMS_GSM_UMTS_TP_CAUSE -QMI_TYPE_WMS_MESSAGE_CLASS -QMI_TYPE_WMS_MESSAGE_DELIVERY_FAILURE_TYPE -QMI_TYPE_WMS_MESSAGE_FORMAT -QMI_TYPE_WMS_MESSAGE_MODE -QMI_TYPE_WMS_MESSAGE_PROTOCOL -QMI_TYPE_WMS_MESSAGE_TAG_TYPE -QMI_TYPE_WMS_MESSAGE_TYPE -QMI_TYPE_WMS_NOTIFICATION_TYPE -QMI_TYPE_WMS_RECEIPT_ACTION -QMI_TYPE_WMS_STORAGE_TYPE -QMI_TYPE_WMS_TRANSFER_INDICATION -qmi_dms_activation_state_get_type -qmi_dms_data_service_capability_get_type -qmi_dms_firmware_image_type_get_type -qmi_dms_offline_reason_get_type -qmi_dms_operating_mode_get_type -qmi_dms_power_state_get_type -qmi_dms_radio_interface_get_type -qmi_dms_sim_capability_get_type -qmi_dms_time_reference_type_get_type -qmi_dms_time_source_get_type -qmi_dms_uim_facility_get_type -qmi_dms_uim_facility_state_get_type -qmi_dms_uim_pin_id_get_type -qmi_dms_uim_pin_status_get_type -qmi_dms_uim_state_get_type qmi_nas_active_band_get_type qmi_nas_attach_state_get_type qmi_nas_call_barring_status_get_type @@ -404,122 +338,6 @@ qmi_nas_signal_strength_request_get_type qmi_nas_sim_reject_state_get_type qmi_nas_td_scdma_band_preference_get_type qmi_nas_wcdma_hs_service_get_type -qmi_pds_data_valid_get_type -qmi_pds_operation_mode_get_type -qmi_pds_position_session_status_get_type -qmi_pds_tracking_session_state_get_type -qmi_service_get_type -qmi_wds_authentication_get_type -qmi_wds_call_end_reason_get_type -qmi_wds_call_type_get_type -qmi_wds_connection_status_get_type -qmi_wds_data_bearer_technology_get_type -qmi_wds_extended_technology_preference_get_type -qmi_wds_get_current_settings_requested_settings_get_type -qmi_wds_ip_family_get_type -qmi_wds_network_type_get_type -qmi_wds_pdp_type_get_type -qmi_wds_profile_type_get_type -qmi_wds_rat_3gpp2_get_type -qmi_wds_rat_3gpp_get_type -qmi_wds_so_cdma1x_get_type -qmi_wds_so_evdo_reva_get_type -qmi_wds_technology_preference_get_type -qmi_wds_traffic_class_get_type -qmi_wds_verbose_call_end_reason_3gpp_get_type -qmi_wds_verbose_call_end_reason_cm_get_type -qmi_wds_verbose_call_end_reason_ehrpd_get_type -qmi_wds_verbose_call_end_reason_internal_get_type -qmi_wds_verbose_call_end_reason_ipv6_get_type -qmi_wds_verbose_call_end_reason_mip_get_type -qmi_wds_verbose_call_end_reason_ppp_get_type -qmi_wds_verbose_call_end_reason_type_get_type -qmi_wms_ack_indicator_get_type -qmi_wms_cdma_cause_code_get_type -qmi_wms_cdma_error_class_get_type -qmi_wms_cdma_service_option_get_type -qmi_wms_gsm_umts_rp_cause_get_type -qmi_wms_gsm_umts_tp_cause_get_type -qmi_wms_message_class_get_type -qmi_wms_message_delivery_failure_type_get_type -qmi_wms_message_format_get_type -qmi_wms_message_mode_get_type -qmi_wms_message_protocol_get_type -qmi_wms_message_tag_type_get_type -qmi_wms_message_type_get_type -qmi_wms_notification_type_get_type -qmi_wms_receipt_action_get_type -qmi_wms_storage_type_get_type -qmi_wms_transfer_indication_get_type -</SECTION> - -<SECTION> -<FILE>qmi-enums</FILE> -QmiService -</SECTION> - -<SECTION> -<FILE>qmi-enums-dms</FILE> -QmiDmsDataServiceCapability -QmiDmsSimCapability -QmiDmsRadioInterface -QmiDmsPowerState -QmiDmsUimPinId -QmiDmsUimPinStatus -QmiDmsOperatingMode -QmiDmsOfflineReason -QmiDmsTimeSource -QmiDmsActivationState -QmiDmsUimFacility -QmiDmsUimFacilityState -QmiDmsUimState -QmiDmsTimeReferenceType -QmiDmsFirmwareImageType -</SECTION> - -<SECTION> -<FILE>qmi-enums-nas</FILE> -QmiNasRadioInterface -QmiNasActiveBand -QmiNasNetworkServiceDomain -QmiNasEvdoSinrLevel -QmiNasSignalStrengthRequest -QmiNasNetworkScanType -QmiNasNetworkStatus -QmiNasNetworkRegisterType -QmiNasRegistrationState -QmiNasAttachState -QmiNasNetworkType -QmiNasRoamingIndicatorStatus -QmiNasDataCapability -QmiNasServiceStatus -QmiNasHdrPersonality -QmiNasCallBarringStatus -QmiNasNetworkDescriptionDisplay -QmiNasNetworkDescriptionEncoding -QmiNasRadioTechnologyPreference -QmiNasPreferenceDuration -QmiNasRatModePreference -QmiNasCdmaPrlPreference -QmiNasRoamingPreference -QmiNasNetworkSelectionPreference -QmiNasChangeDuration -QmiNasServiceDomainPreference -QmiNasGsmWcdmaAcquisitionOrderPreference -QmiNasTdScdmaBandPreference -QmiNasRoamingStatus -QmiNasHdrProtocolRevision -QmiNasWcdmaHsService -QmiNasCellBroadcastCapability -QmiNasSimRejectState -</SECTION> - -<SECTION> -<FILE>qmi-enums-pds</FILE> -QmiPdsOperationMode -QmiPdsPositionSessionStatus -QmiPdsDataValid -QmiPdsTrackingSessionState </SECTION> <SECTION> @@ -530,7 +348,6 @@ QmiWdsExtendedTechnologyPreference QmiWdsCallType QmiWdsCallEndReason QmiWdsVerboseCallEndReasonType -qmi_wds_verbose_call_end_reason_get_string QmiWdsVerboseCallEndReasonMip QmiWdsVerboseCallEndReasonInternal QmiWdsVerboseCallEndReasonCm @@ -550,6 +367,110 @@ QmiWdsPdpType QmiWdsTrafficClass QmiWdsAuthentication QmiWdsProfileType +<SUBSECTION Methods> +qmi_wds_ip_family_get_string +qmi_wds_technology_preference_build_string_from_mask +qmi_wds_extended_technology_preference_get_string +qmi_wds_call_type_get_string +qmi_wds_call_end_reason_get_string +qmi_wds_verbose_call_end_reason_get_string +qmi_wds_verbose_call_end_reason_type_get_string +qmi_wds_verbose_call_end_reason_mip_get_string +qmi_wds_verbose_call_end_reason_internal_get_string +qmi_wds_verbose_call_end_reason_cm_get_string +qmi_wds_verbose_call_end_reason_3gpp_get_string +qmi_wds_verbose_call_end_reason_ppp_get_string +qmi_wds_verbose_call_end_reason_ehrpd_get_string +qmi_wds_verbose_call_end_reason_ipv6_get_string +qmi_wds_connection_status_get_string +qmi_wds_data_bearer_technology_get_string +qmi_wds_network_type_get_string +qmi_wds_rat_3gpp2_build_string_from_mask +qmi_wds_rat_3gpp_build_string_from_mask +qmi_wds_so_cdma1x_build_string_from_mask +qmi_wds_so_evdo_reva_build_string_from_mask +qmi_wds_get_current_settings_requested_settings_get_string +qmi_wds_pdp_type_get_string +qmi_wds_traffic_class_get_string +qmi_wds_authentication_build_string_from_mask +qmi_wds_profile_type_get_string +<SUBSECTION Private> +qmi_wds_ip_family_build_string_from_mask +qmi_wds_technology_preference_get_string +qmi_wds_extended_technology_preference_build_string_from_mask +qmi_wds_call_type_build_string_from_mask +qmi_wds_call_end_reason_build_string_from_mask +qmi_wds_verbose_call_end_reason_type_build_string_from_mask +qmi_wds_verbose_call_end_reason_mip_build_string_from_mask +qmi_wds_verbose_call_end_reason_internal_build_string_from_mask +qmi_wds_verbose_call_end_reason_cm_build_string_from_mask +qmi_wds_verbose_call_end_reason_3gpp_build_string_from_mask +qmi_wds_verbose_call_end_reason_ppp_build_string_from_mask +qmi_wds_verbose_call_end_reason_ehrpd_build_string_from_mask +qmi_wds_verbose_call_end_reason_ipv6_build_string_from_mask +qmi_wds_connection_status_build_string_from_mask +qmi_wds_data_bearer_technology_build_string_from_mask +qmi_wds_network_type_build_string_from_mask +qmi_wds_rat_3gpp2_get_string +qmi_wds_rat_3gpp_get_string +qmi_wds_so_cdma1x_get_string +qmi_wds_so_evdo_reva_get_string +qmi_wds_get_current_settings_requested_settings_build_string_from_mask +qmi_wds_pdp_type_build_string_from_mask +qmi_wds_traffic_class_build_string_from_mask +qmi_wds_authentication_get_string +qmi_wds_profile_type_build_string_from_mask +<SUBSECTION Standard> +QMI_TYPE_WDS_AUTHENTICATION +QMI_TYPE_WDS_CALL_END_REASON +QMI_TYPE_WDS_CALL_TYPE +QMI_TYPE_WDS_CONNECTION_STATUS +QMI_TYPE_WDS_DATA_BEARER_TECHNOLOGY +QMI_TYPE_WDS_EXTENDED_TECHNOLOGY_PREFERENCE +QMI_TYPE_WDS_GET_CURRENT_SETTINGS_REQUESTED_SETTINGS +QMI_TYPE_WDS_IP_FAMILY +QMI_TYPE_WDS_NETWORK_TYPE +QMI_TYPE_WDS_PDP_TYPE +QMI_TYPE_WDS_PROFILE_TYPE +QMI_TYPE_WDS_RAT_3GPP +QMI_TYPE_WDS_RAT_3GPP2 +QMI_TYPE_WDS_SO_CDMA1X +QMI_TYPE_WDS_SO_EVDO_REVA +QMI_TYPE_WDS_TECHNOLOGY_PREFERENCE +QMI_TYPE_WDS_TRAFFIC_CLASS +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_3GPP +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_CM +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_EHRPD +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_INTERNAL +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_IPV6 +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_MIP +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_PPP +QMI_TYPE_WDS_VERBOSE_CALL_END_REASON_TYPE +qmi_wds_authentication_get_type +qmi_wds_call_end_reason_get_type +qmi_wds_call_type_get_type +qmi_wds_connection_status_get_type +qmi_wds_data_bearer_technology_get_type +qmi_wds_extended_technology_preference_get_type +qmi_wds_get_current_settings_requested_settings_get_type +qmi_wds_ip_family_get_type +qmi_wds_network_type_get_type +qmi_wds_pdp_type_get_type +qmi_wds_profile_type_get_type +qmi_wds_rat_3gpp2_get_type +qmi_wds_rat_3gpp_get_type +qmi_wds_so_cdma1x_get_type +qmi_wds_so_evdo_reva_get_type +qmi_wds_technology_preference_get_type +qmi_wds_traffic_class_get_type +qmi_wds_verbose_call_end_reason_3gpp_get_type +qmi_wds_verbose_call_end_reason_cm_get_type +qmi_wds_verbose_call_end_reason_ehrpd_get_type +qmi_wds_verbose_call_end_reason_internal_get_type +qmi_wds_verbose_call_end_reason_ipv6_get_type +qmi_wds_verbose_call_end_reason_mip_get_type +qmi_wds_verbose_call_end_reason_ppp_get_type +qmi_wds_verbose_call_end_reason_type_get_type </SECTION> <SECTION> @@ -571,15 +492,120 @@ QmiWmsMessageType QmiWmsMessageClass QmiWmsReceiptAction QmiWmsTransferIndication +<SUBSECTION Methods> +qmi_wms_storage_type_get_string +qmi_wms_ack_indicator_get_string +qmi_wms_message_format_get_string +qmi_wms_message_mode_get_string +qmi_wms_notification_type_get_string +qmi_wms_cdma_service_option_get_string +qmi_wms_cdma_cause_code_get_string +qmi_wms_cdma_error_class_get_string +qmi_wms_gsm_umts_rp_cause_get_string +qmi_wms_gsm_umts_tp_cause_get_string +qmi_wms_message_delivery_failure_type_get_string +qmi_wms_message_tag_type_get_string +qmi_wms_message_protocol_get_string +qmi_wms_message_type_get_string +qmi_wms_message_class_get_string +qmi_wms_receipt_action_get_string +qmi_wms_transfer_indication_get_string +<SUBSECTION Private> +qmi_wms_storage_type_build_string_from_mask +qmi_wms_ack_indicator_build_string_from_mask +qmi_wms_message_format_build_string_from_mask +qmi_wms_message_mode_build_string_from_mask +qmi_wms_notification_type_build_string_from_mask +qmi_wms_cdma_service_option_build_string_from_mask +qmi_wms_cdma_cause_code_build_string_from_mask +qmi_wms_cdma_error_class_build_string_from_mask +qmi_wms_gsm_umts_rp_cause_build_string_from_mask +qmi_wms_gsm_umts_tp_cause_build_string_from_mask +qmi_wms_message_delivery_failure_type_build_string_from_mask +qmi_wms_message_tag_type_build_string_from_mask +qmi_wms_message_protocol_build_string_from_mask +qmi_wms_message_type_build_string_from_mask +qmi_wms_message_class_build_string_from_mask +qmi_wms_receipt_action_build_string_from_mask +qmi_wms_transfer_indication_build_string_from_mask +<SUBSECTION Standard> +QMI_TYPE_WMS_ACK_INDICATOR +QMI_TYPE_WMS_CDMA_CAUSE_CODE +QMI_TYPE_WMS_CDMA_ERROR_CLASS +QMI_TYPE_WMS_CDMA_SERVICE_OPTION +QMI_TYPE_WMS_GSM_UMTS_RP_CAUSE +QMI_TYPE_WMS_GSM_UMTS_TP_CAUSE +QMI_TYPE_WMS_MESSAGE_CLASS +QMI_TYPE_WMS_MESSAGE_DELIVERY_FAILURE_TYPE +QMI_TYPE_WMS_MESSAGE_FORMAT +QMI_TYPE_WMS_MESSAGE_MODE +QMI_TYPE_WMS_MESSAGE_PROTOCOL +QMI_TYPE_WMS_MESSAGE_TAG_TYPE +QMI_TYPE_WMS_MESSAGE_TYPE +QMI_TYPE_WMS_NOTIFICATION_TYPE +QMI_TYPE_WMS_RECEIPT_ACTION +QMI_TYPE_WMS_STORAGE_TYPE +QMI_TYPE_WMS_TRANSFER_INDICATION +qmi_wms_ack_indicator_get_type +qmi_wms_cdma_cause_code_get_type +qmi_wms_cdma_error_class_get_type +qmi_wms_cdma_service_option_get_type +qmi_wms_gsm_umts_rp_cause_get_type +qmi_wms_gsm_umts_tp_cause_get_type +qmi_wms_message_class_get_type +qmi_wms_message_delivery_failure_type_get_type +qmi_wms_message_format_get_type +qmi_wms_message_mode_get_type +qmi_wms_message_protocol_get_type +qmi_wms_message_tag_type_get_type +qmi_wms_message_type_get_type +qmi_wms_notification_type_get_type +qmi_wms_receipt_action_get_type +qmi_wms_storage_type_get_type +qmi_wms_transfer_indication_get_type </SECTION> <SECTION> -<FILE>qmi-error-types</FILE> -qmi_core_error_quark +<FILE>qmi-enums-pds</FILE> +QmiPdsOperationMode +QmiPdsPositionSessionStatus +QmiPdsDataValid +QmiPdsTrackingSessionState +<SUBSECTION Methods> +qmi_pds_operation_mode_get_string +qmi_pds_position_session_status_get_string +qmi_pds_data_valid_build_string_from_mask +qmi_pds_tracking_session_state_get_string +<SUBSECTION Private> +qmi_pds_operation_mode_build_string_from_mask +qmi_pds_position_session_status_build_string_from_mask +qmi_pds_data_valid_get_string +qmi_pds_tracking_session_state_build_string_from_mask +<SUBSECTION Standard> +QMI_TYPE_PDS_DATA_VALID +QMI_TYPE_PDS_OPERATION_MODE +QMI_TYPE_PDS_POSITION_SESSION_STATUS +QMI_TYPE_PDS_TRACKING_SESSION_STATE +qmi_pds_data_valid_get_type +qmi_pds_operation_mode_get_type +qmi_pds_position_session_status_get_type +qmi_pds_tracking_session_state_get_type +</SECTION> + +<SECTION> +<FILE>qmi-errors</FILE> +QmiCoreError +QmiProtocolError +<SUBSECTION Methods> qmi_core_error_get_string -qmi_protocol_error_quark qmi_protocol_error_get_string +<SUBSECTION Private> +QMI_DBUS_ERROR_PREFIX +QMI_CORE_ERROR_DBUS_PREFIX +QMI_PROTOCOL_ERROR_DBUS_PREFIX <SUBSECTION Standard> +qmi_core_error_quark +qmi_protocol_error_quark QMI_CORE_ERROR QMI_PROTOCOL_ERROR QMI_TYPE_CORE_ERROR @@ -589,35 +615,6 @@ qmi_protocol_error_get_type </SECTION> <SECTION> -<FILE>qmi-errors</FILE> -QMI_DBUS_ERROR_PREFIX -QMI_CORE_ERROR_DBUS_PREFIX -QMI_PROTOCOL_ERROR_DBUS_PREFIX -QmiCoreError -QmiProtocolError -</SECTION> - -<SECTION> -<FILE>qmi-flags64-dms</FILE> -QmiDmsBandCapability -QmiDmsLteBandCapability -</SECTION> - -<SECTION> -<FILE>qmi-flags64-nas</FILE> -QmiNasBandPreference -QmiNasLteBandPreference -</SECTION> - -<SECTION> -<FILE>qmi-flags64-types</FILE> -qmi_dms_band_capability_build_string_from_mask -qmi_dms_lte_band_capability_build_string_from_mask -qmi_nas_band_preference_build_string_from_mask -qmi_nas_lte_band_preference_build_string_from_mask -</SECTION> - -<SECTION> <FILE>qmi-message</FILE> QMI_MESSAGE_QMUX_MARKER QmiMessage diff --git a/docs/reference/libqmi-glib/libqmi-glib-docs.xml b/docs/reference/libqmi-glib/libqmi-glib-docs.xml index c567d6c..d3b5a4e 100644 --- a/docs/reference/libqmi-glib/libqmi-glib-docs.xml +++ b/docs/reference/libqmi-glib/libqmi-glib-docs.xml @@ -43,10 +43,7 @@ <xi:include href="xml/qmi-device.xml"/> <xi:include href="xml/qmi-client.xml"/> <xi:include href="xml/qmi-enums.xml"/> - <xi:include href="xml/qmi-enum-types.xml"/> - <xi:include href="xml/qmi-flags64-types.xml"/> <xi:include href="xml/qmi-errors.xml"/> - <xi:include href="xml/qmi-error-types.xml"/> <xi:include href="xml/qmi-utils.xml"/> </chapter> @@ -54,7 +51,6 @@ <title>Device Management Service (DMS)</title> <xi:include href="xml/qmi-client-dms.xml"/> <xi:include href="xml/qmi-enums-dms.xml"/> - <xi:include href="xml/qmi-flags64-dms.xml"/> <section> <title>DMS Indications</title> <xi:include href="xml/qmi-indication-dms-event-report.xml"/> @@ -116,7 +112,6 @@ <title>Network Access Service (NAS)</title> <xi:include href="xml/qmi-client-nas.xml"/> <xi:include href="xml/qmi-enums-nas.xml"/> - <xi:include href="xml/qmi-flags64-nas.xml"/> <section> <title>NAS Indications</title> <xi:include href="xml/qmi-indication-nas-event-report.xml"/> diff --git a/libqmi-glib/qmi-enums-dms.h b/libqmi-glib/qmi-enums-dms.h index d5d83f3..3476c4d 100644 --- a/libqmi-glib/qmi-enums-dms.h +++ b/libqmi-glib/qmi-enums-dms.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-dms + * @title: DMS enumerations and flags + * + * This section defines enumerations and flags used in the DMS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI DMS Get Capabilities' message */ diff --git a/libqmi-glib/qmi-enums-nas.h b/libqmi-glib/qmi-enums-nas.h index 7d7055d..1d6ac10 100644 --- a/libqmi-glib/qmi-enums-nas.h +++ b/libqmi-glib/qmi-enums-nas.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-nas + * @title: NAS enumerations and flags + * + * This section defines enumerations and flags used in the NAS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI NAS Event Report' indication */ diff --git a/libqmi-glib/qmi-enums-pds.h b/libqmi-glib/qmi-enums-pds.h index 8a64910..c6382cc 100644 --- a/libqmi-glib/qmi-enums-pds.h +++ b/libqmi-glib/qmi-enums-pds.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-pds + * @title: PDS enumerations and flags + * + * This section defines enumerations and flags used in the PDS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI PDS Event Report' indication */ diff --git a/libqmi-glib/qmi-enums-wds.h b/libqmi-glib/qmi-enums-wds.h index 0c419aa..d8f765f 100644 --- a/libqmi-glib/qmi-enums-wds.h +++ b/libqmi-glib/qmi-enums-wds.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-wds + * @title: WDS enumerations and flags + * + * This section defines enumerations and flags used in the WDS service + * interface. + */ + #include <glib.h> /*****************************************************************************/ @@ -917,7 +925,6 @@ typedef enum { /*< underscore_name=qmi_wds_authentication >*/ QMI_WDS_AUTHENTICATION_CHAP = 1 << 1 } QmiWdsAuthentication; - /** * QmiWdsProfileType: * @QMI_WDS_PROFILE_TYPE_3GPP: 3GPP profile type. diff --git a/libqmi-glib/qmi-enums-wms.h b/libqmi-glib/qmi-enums-wms.h index 12637cf..d2df5bc 100644 --- a/libqmi-glib/qmi-enums-wms.h +++ b/libqmi-glib/qmi-enums-wms.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-wms + * @title: WMS enumerations and flags + * + * This section defines enumerations and flags used in the WMS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI WMS Event Report' indication */ diff --git a/libqmi-glib/qmi-enums.h b/libqmi-glib/qmi-enums.h index d16f1cc..e3cba79 100644 --- a/libqmi-glib/qmi-enums.h +++ b/libqmi-glib/qmi-enums.h @@ -28,6 +28,13 @@ #endif /** + * SECTION: qmi-enums + * @title: Common enumerations and flags + * + * This section defines common enumerations and flags used in the interface. + */ + +/** * QmiService: * @QMI_SERVICE_UNKNOWN: Unknown service. * @QMI_SERVICE_CTL: Control service. diff --git a/libqmi-glib/qmi-errors.h b/libqmi-glib/qmi-errors.h index 9dcb9ff..cafbb4c 100644 --- a/libqmi-glib/qmi-errors.h +++ b/libqmi-glib/qmi-errors.h @@ -27,6 +27,13 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-errors + * @title: Errors + * + * This section defines common error types used in the interface. + */ + /* Prefixes for errors registered in DBus */ #define QMI_DBUS_ERROR_PREFIX "org.freedesktop.libqmi.Error" #define QMI_CORE_ERROR_DBUS_PREFIX QMI_DBUS_ERROR_PREFIX ".Core" |