libmm-glib,firmware-properties: improve documentation

3 files changed, 33 insertions, 6 deletions

diff --git a/docs/reference/libmm-glib/libmm-glib-sections.txt b/docs/reference/libmm-glib/libmm-glib-sections.txt
index 605b6e1f..53eb5f6c 100644
--- a/docs/reference/libmm-glib/libmm-glib-sections.txt
+++ b/docs/reference/libmm-glib/libmm-glib-sections.txt
@@ -530,14 +530,16 @@ mm_modem_firmware_get_type
 <FILE>mm-firmware-properties</FILE>
 <TITLE>MMFirmwareProperties</TITLE>
 MMFirmwareProperties
-MMFirmwarePropertiesClass
-mm_firmware_properties_get_dictionary
+<SUBSECTION Getters>
 mm_firmware_properties_get_image_type
 mm_firmware_properties_get_name
 mm_firmware_properties_get_version
+<SUBSECTION Private>
 mm_firmware_properties_new
 mm_firmware_properties_new_from_dictionary
+mm_firmware_properties_get_dictionary
 <SUBSECTION Standard>
+MMFirmwarePropertiesClass
 MMFirmwarePropertiesPrivate
 MM_FIRMWARE_PROPERTIES
 MM_FIRMWARE_PROPERTIES_CLASS
diff --git a/libmm-glib/mm-firmware-properties.c b/libmm-glib/mm-firmware-properties.c
index 8ef8347b..44097e4a 100644
--- a/libmm-glib/mm-firmware-properties.c
+++ b/libmm-glib/mm-firmware-properties.c
@@ -19,6 +19,18 @@
 #include "mm-common-helpers.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);
 
 #define PROPERTY_NAME       "name"
@@ -52,6 +64,8 @@ mm_firmware_properties_get_name (MMFirmwareProperties *self)
     return self->priv->name;
 }
 
+/*****************************************************************************/
+
 /**
  * mm_firmware_properties_get_version:
  * @self: A #MMFirmwareProperties.
@@ -68,6 +82,8 @@ mm_firmware_properties_get_version (MMFirmwareProperties *self)
     return self->priv->version;
 }
 
+/*****************************************************************************/
+
 /**
  * mm_firmware_properties_get_image_type:
  * @self: A #MMFirmwareProperties.
diff --git a/libmm-glib/mm-firmware-properties.h b/libmm-glib/mm-firmware-properties.h
index f2375db6..eb7cae68 100644
--- a/libmm-glib/mm-firmware-properties.h
+++ b/libmm-glib/mm-firmware-properties.h
@@ -55,18 +55,27 @@ struct _MMFirmwarePropertiesClass {
 
 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,
                                                   const gchar *name,
                                                   const gchar *version);
 MMFirmwareProperties *mm_firmware_properties_new_from_dictionary (GVariant *dictionary,
                                                                   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);
 
+#endif
+
 G_END_DECLS
 
 #endif /* MM_FIRMWARE_PROPERTIES_H */