libmm-glib,pco: add some more missing documentation for MMPco

This commit is contained in:
Aleksander Morgado
2018-08-28 10:50:44 +02:00
parent c49f60db02
commit 8e98922880
+14 -4
View File
@@ -158,6 +158,16 @@ mm_pco_set_data (MMPco *self,
/*****************************************************************************/
/**
* mm_pco_from_variant:
* @variant: A variant with the PCO information.
* @error: Return location for error or %NULL.
*
* Creates a new #MMPco object with the values exposed in
* the variant.
*
* Returns: (transfer full): A #MMPco or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMPco *
mm_pco_from_variant (GVariant *variant,
GError **error)
@@ -234,7 +244,7 @@ mm_pco_to_variant (MMPco *self)
/**
* mm_pco_list_free:
* @pco_list (element-type ModemManager.Pco): a #GList of #MMPco.
* @pco_list: (transfer full)(element-type ModemManager.Pco): a #GList of #MMPco.
*
* Frees all of the memory used by a #GList of #MMPco.
*/
@@ -246,14 +256,14 @@ mm_pco_list_free (GList *pco_list)
/**
* mm_pco_list_add:
* @pco_list (element-type ModemManager.Pco): a #GList of #MMPco.
* @pco:: a #MMPco to add to the given list.
* @pco_list: (transfer full)(element-type ModemManager.Pco): a #GList of #MMPco.
* @pco: (transfer none): a #MMPco to add to the given list.
*
* Adds a #MMPco to a given PCO list. #MMPco objects stored in the order of
* their session ID. An existing PCO with the same session ID is overwritten
* with the new value.
*
* Returns: (element-type ModemManager.Pco): the new start of an updated or newly allocated #GList of #MMPco.
* Returns: (transfer full)(element-type ModemManager.Pco): the new start of an updated or newly allocated #GList of #MMPco.
*/
GList *
mm_pco_list_add (GList *pco_list,