diff options
author | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-03 16:19:14 +0200 |
---|---|---|
committer | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-04 10:17:12 +0200 |
commit | 030daafc4554a20f53d1fee48a588e7907393716 (patch) | |
tree | fb06d2c850a20936e54c6dbc842f0d0505199be8 /libmm-glib/mm-location-gps-nmea.h | |
parent | 7edc3508c766f64ec21825695ce98730a289429c (diff) |
libmm-glib,location-gps-nmea: improve documentation
Diffstat (limited to 'libmm-glib/mm-location-gps-nmea.h')
-rw-r--r-- | libmm-glib/mm-location-gps-nmea.h | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/libmm-glib/mm-location-gps-nmea.h b/libmm-glib/mm-location-gps-nmea.h index 84f1dfdd..e0269da6 100644 --- a/libmm-glib/mm-location-gps-nmea.h +++ b/libmm-glib/mm-location-gps-nmea.h @@ -36,17 +36,36 @@ typedef struct _MMLocationGpsNmea MMLocationGpsNmea; typedef struct _MMLocationGpsNmeaClass MMLocationGpsNmeaClass; typedef struct _MMLocationGpsNmeaPrivate MMLocationGpsNmeaPrivate; +/** + * MMLocationGpsNmea: + * + * The #MMLocationGpsNmea structure contains private data and should + * only be accessed using the provided API. + */ struct _MMLocationGpsNmea { + /*< private >*/ GObject parent; MMLocationGpsNmeaPrivate *priv; }; struct _MMLocationGpsNmeaClass { + /*< private >*/ GObjectClass parent; }; GType mm_location_gps_nmea_get_type (void); +const gchar *mm_location_gps_nmea_get_trace (MMLocationGpsNmea *self, + const gchar *trace_type); +gchar *mm_location_gps_nmea_build_full (MMLocationGpsNmea *self); + +/*****************************************************************************/ +/* ModemManager/libmm-glib/mmcli specific methods */ + +#if defined (_LIBMM_INSIDE_MM) || \ + defined (_LIBMM_INSIDE_MMCLI) || \ + defined (LIBMM_GLIB_COMPILATION) + MMLocationGpsNmea *mm_location_gps_nmea_new (void); MMLocationGpsNmea *mm_location_gps_nmea_new_from_string_variant (GVariant *string, GError **error); @@ -54,10 +73,6 @@ MMLocationGpsNmea *mm_location_gps_nmea_new_from_string_variant (GVariant *strin gboolean mm_location_gps_nmea_add_trace (MMLocationGpsNmea *self, const gchar *trace); -const gchar *mm_location_gps_nmea_get_trace (MMLocationGpsNmea *self, - const gchar *trace_type); -gchar *mm_location_gps_nmea_build_full (MMLocationGpsNmea *self); - GVariant *mm_location_gps_nmea_get_string_variant (MMLocationGpsNmea *self); G_END_DECLS |