[PATCH] libmm-glib,pco: add missing documentation for MMPco

[Aleksander Morgado]

On Mon, Aug 27, 2018 at 9:55 PM, Ben Chan <benchan at chromium.org> wrote:
> ---
>  libmm-glib/mm-modem-3gpp.c |  2 +-
>  libmm-glib/mm-pco.c        | 25 +++++++++++++++++++++++++
>  2 files changed, 26 insertions(+), 1 deletion(-)
>

Pushed it to git master, and an additional follow up patch to fix
several missing things.


> diff --git a/libmm-glib/mm-modem-3gpp.c b/libmm-glib/mm-modem-3gpp.c
> index 360aaef6..80746f98 100644
> --- a/libmm-glib/mm-modem-3gpp.c
> +++ b/libmm-glib/mm-modem-3gpp.c
> @@ -308,7 +308,7 @@ mm_modem_3gpp_get_eps_ue_mode_operation (MMModem3gpp *self)
>   * The caller is responsible for freeing the returned #GList with
>   * mm_pco_list_free().
>   *
> - * Returns: (transfer full): A list of #MMPco.
> + * Returns: (element-type ModemManager.Pco) (transfer full): A list of #MMPco.
>   */
>  GList *
>  mm_modem_3gpp_get_pco (MMModem3gpp *self)
> diff --git a/libmm-glib/mm-pco.c b/libmm-glib/mm-pco.c
> index 7ee347b0..0afa1b4b 100644
> --- a/libmm-glib/mm-pco.c
> +++ b/libmm-glib/mm-pco.c
> @@ -193,6 +193,14 @@ mm_pco_from_variant (GVariant *variant,
>
>  /*****************************************************************************/
>
> +/**
> + * mm_pco_to_variant:
> + * @self: a #MMPco.
> + *
> + * Gets a GVariant representation with signature "(ubay)" of @self.
> + *
> + * Returns: (transfer full): A #GVariant representation of the #MMPco object. The returned value should be freed with g_variant_unref().
> + */
>  GVariant *
>  mm_pco_to_variant (MMPco *self)
>  {
> @@ -224,12 +232,29 @@ mm_pco_to_variant (MMPco *self)
>
>  /*****************************************************************************/
>
> +/**
> + * mm_pco_list_free:
> + * @pco_list (element-type ModemManager.Pco): a #GList of #MMPco.
> + *
> + * Frees all of the memory used by a #GList of #MMPco.
> + */
>  void
>  mm_pco_list_free (GList *pco_list)
>  {
>      g_list_free_full (pco_list, g_object_unref);
>  }
>
> +/**
> + * mm_pco_list_add:
> + * @pco_list (element-type ModemManager.Pco): a #GList of #MMPco.
> + * @pco:: 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.
> + */
>  GList *
>  mm_pco_list_add (GList *pco_list,
>                   MMPco *pco)
> --
> 2.19.0.rc0.228.g281dcd1b4d0-goog
>



-- 
Aleksander
https://aleksander.es