colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libmm-glib,firmware-properties: improve documentation

Browse Source
This commit is contained in:
Aleksander Morgado
2012-10-03 16:46:31 +02:00
parent dc4656cead
commit 54c2ee77b0
3 changed files with 33 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/libmm-glib/libmm-glib-sections.txt
View File

@@ -530,14 +530,16 @@ mm_modem_firmware_get_type
<FILE>mm-firmware-properties</FILE> <FILE>mm-firmware-properties</FILE>
<TITLE>MMFirmwareProperties</TITLE> <TITLE>MMFirmwareProperties</TITLE>
MMFirmwareProperties MMFirmwareProperties
MMFirmwarePropertiesClass <SUBSECTION Getters>
mm_firmware_properties_get_dictionary
mm_firmware_properties_get_image_type mm_firmware_properties_get_image_type
mm_firmware_properties_get_name mm_firmware_properties_get_name
mm_firmware_properties_get_version mm_firmware_properties_get_version
<SUBSECTION Private>
mm_firmware_properties_new mm_firmware_properties_new
mm_firmware_properties_new_from_dictionary mm_firmware_properties_new_from_dictionary
mm_firmware_properties_get_dictionary
<SUBSECTION Standard> <SUBSECTION Standard>
MMFirmwarePropertiesClass
MMFirmwarePropertiesPrivate MMFirmwarePropertiesPrivate
MM_FIRMWARE_PROPERTIES MM_FIRMWARE_PROPERTIES
MM_FIRMWARE_PROPERTIES_CLASS MM_FIRMWARE_PROPERTIES_CLASS

16
libmm-glib/mm-firmware-properties.c
View File

@@ -19,6 +19,18 @@
#include "mm-common-helpers.h" #include "mm-common-helpers.h"
#include "mm-firmware-properties.h" #include "mm-firmware-properties.h"
/**
* SECTION: mm-firmware-properties
* @title: MMFirmwareProperties
* @short_description: Helper object to handle firmware information.
*
* The #MMFirmwareProperties is an object handling the properties exposed for
* available firmware images.
*
* This object is retrieved with either mm_modem_firmware_list()
* or mm_modem_firmware_list_sync().
*/
G_DEFINE_TYPE (MMFirmwareProperties, mm_firmware_properties, G_TYPE_OBJECT); G_DEFINE_TYPE (MMFirmwareProperties, mm_firmware_properties, G_TYPE_OBJECT);
#define PROPERTY_NAME "name" #define PROPERTY_NAME "name"
@@ -52,6 +64,8 @@ mm_firmware_properties_get_name (MMFirmwareProperties *self)
return self->priv->name; return self->priv->name;
} }
/*****************************************************************************/
/** /**
* mm_firmware_properties_get_version: * mm_firmware_properties_get_version:
* @self: A #MMFirmwareProperties. * @self: A #MMFirmwareProperties.
@@ -68,6 +82,8 @@ mm_firmware_properties_get_version (MMFirmwareProperties *self)
return self->priv->version; return self->priv->version;
} }
/*****************************************************************************/
/** /**
* mm_firmware_properties_get_image_type: * mm_firmware_properties_get_image_type:
* @self: A #MMFirmwareProperties. * @self: A #MMFirmwareProperties.

17
libmm-glib/mm-firmware-properties.h
View File

@@ -55,18 +55,27 @@ struct _MMFirmwarePropertiesClass {
GType mm_firmware_properties_get_type (void); GType mm_firmware_properties_get_type (void);
const gchar *mm_firmware_properties_get_name (MMFirmwareProperties *self);
const gchar *mm_firmware_properties_get_version (MMFirmwareProperties *self);
MMFirmwareImageType mm_firmware_properties_get_image_type (MMFirmwareProperties *self);
/*****************************************************************************/
/* ModemManager/libmm-glib/mmcli specific methods */
#if defined (_LIBMM_INSIDE_MM) || \
defined (_LIBMM_INSIDE_MMCLI) || \
defined (LIBMM_GLIB_COMPILATION)
MMFirmwareProperties *mm_firmware_properties_new (MMFirmwareImageType image_type, MMFirmwareProperties *mm_firmware_properties_new (MMFirmwareImageType image_type,
const gchar *name, const gchar *name,
const gchar *version); const gchar *version);
MMFirmwareProperties *mm_firmware_properties_new_from_dictionary (GVariant *dictionary, MMFirmwareProperties *mm_firmware_properties_new_from_dictionary (GVariant *dictionary,
GError **error); GError **error);
const gchar *mm_firmware_properties_get_name (MMFirmwareProperties *properties);
const gchar *mm_firmware_properties_get_version (MMFirmwareProperties *properties);
MMFirmwareImageType mm_firmware_properties_get_image_type (MMFirmwareProperties *properties);
GVariant *mm_firmware_properties_get_dictionary (MMFirmwareProperties *self); GVariant *mm_firmware_properties_get_dictionary (MMFirmwareProperties *self);
#endif
G_END_DECLS G_END_DECLS
#endif /* MM_FIRMWARE_PROPERTIES_H */ #endif /* MM_FIRMWARE_PROPERTIES_H */