From f99ac11cbb9acd00c889eb11e58d690196ed929c Mon Sep 17 00:00:00 2001 From: Aleksander Morgado Date: Wed, 3 Oct 2012 14:35:46 +0200 Subject: libmm-glib,simple-status: improve documentation --- libmm-glib/mm-simple-status.h | 52 +++++++++++++++++++++++++++++-------------- 1 file changed, 35 insertions(+), 17 deletions(-) (limited to 'libmm-glib/mm-simple-status.h') diff --git a/libmm-glib/mm-simple-status.h b/libmm-glib/mm-simple-status.h index fa535616..f61a34cc 100644 --- a/libmm-glib/mm-simple-status.h +++ b/libmm-glib/mm-simple-status.h @@ -32,38 +32,29 @@ G_BEGIN_DECLS #define MM_IS_SIMPLE_STATUS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_SIMPLE_STATUS)) #define MM_SIMPLE_STATUS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_SIMPLE_STATUS, MMSimpleStatusClass)) -#define MM_SIMPLE_PROPERTY_STATE "state" -#define MM_SIMPLE_PROPERTY_SIGNAL_QUALITY "signal-quality" -#define MM_SIMPLE_PROPERTY_BANDS "bands" -#define MM_SIMPLE_PROPERTY_ACCESS_TECHNOLOGIES "access-technologies" - -#define MM_SIMPLE_PROPERTY_3GPP_REGISTRATION_STATE "m3gpp-registration-state" -#define MM_SIMPLE_PROPERTY_3GPP_OPERATOR_CODE "m3gpp-operator-code" -#define MM_SIMPLE_PROPERTY_3GPP_OPERATOR_NAME "m3gpp-operator-name" - -#define MM_SIMPLE_PROPERTY_CDMA_CDMA1X_REGISTRATION_STATE "cdma-cdma1x-registration-state" -#define MM_SIMPLE_PROPERTY_CDMA_EVDO_REGISTRATION_STATE "cdma-evdo-registration-state" -#define MM_SIMPLE_PROPERTY_CDMA_SID "cdma-sid" -#define MM_SIMPLE_PROPERTY_CDMA_NID "cdma-nid" - typedef struct _MMSimpleStatus MMSimpleStatus; typedef struct _MMSimpleStatusClass MMSimpleStatusClass; typedef struct _MMSimpleStatusPrivate MMSimpleStatusPrivate; +/** + * MMSimpleStatus: + * + * The #MMSimpleStatus structure contains private data and should + * only be accessed using the provided API. + */ struct _MMSimpleStatus { + /*< private >*/ GObject parent; MMSimpleStatusPrivate *priv; }; struct _MMSimpleStatusClass { + /*< private >*/ GObjectClass parent; }; GType mm_simple_status_get_type (void); -MMSimpleStatus *mm_simple_status_new (void); -MMSimpleStatus *mm_simple_status_new_from_dictionary (GVariant *dictionary, - GError **error); MMModemState mm_simple_status_get_state (MMSimpleStatus *self); guint32 mm_simple_status_get_signal_quality (MMSimpleStatus *self, @@ -82,8 +73,35 @@ MMModemCdmaRegistrationState mm_simple_status_get_cdma_evdo_registration_state guint mm_simple_status_get_cdma_sid (MMSimpleStatus *self); guint mm_simple_status_get_cdma_nid (MMSimpleStatus *self); +/*****************************************************************************/ +/* ModemManager/libmm-glib/mmcli specific methods */ + +#if defined (_LIBMM_INSIDE_MM) || \ + defined (_LIBMM_INSIDE_MMCLI) || \ + defined (LIBMM_GLIB_COMPILATION) + +#define MM_SIMPLE_PROPERTY_STATE "state" +#define MM_SIMPLE_PROPERTY_SIGNAL_QUALITY "signal-quality" +#define MM_SIMPLE_PROPERTY_BANDS "bands" +#define MM_SIMPLE_PROPERTY_ACCESS_TECHNOLOGIES "access-technologies" + +#define MM_SIMPLE_PROPERTY_3GPP_REGISTRATION_STATE "m3gpp-registration-state" +#define MM_SIMPLE_PROPERTY_3GPP_OPERATOR_CODE "m3gpp-operator-code" +#define MM_SIMPLE_PROPERTY_3GPP_OPERATOR_NAME "m3gpp-operator-name" + +#define MM_SIMPLE_PROPERTY_CDMA_CDMA1X_REGISTRATION_STATE "cdma-cdma1x-registration-state" +#define MM_SIMPLE_PROPERTY_CDMA_EVDO_REGISTRATION_STATE "cdma-evdo-registration-state" +#define MM_SIMPLE_PROPERTY_CDMA_SID "cdma-sid" +#define MM_SIMPLE_PROPERTY_CDMA_NID "cdma-nid" + +MMSimpleStatus *mm_simple_status_new (void); +MMSimpleStatus *mm_simple_status_new_from_dictionary (GVariant *dictionary, + GError **error); + GVariant *mm_simple_status_get_dictionary (MMSimpleStatus *self); +#endif + G_END_DECLS #endif /* MM_SIMPLE_STATUS_H */ -- cgit v1.2.3-70-g09d2