[geocode-glib] geocode-glib: Fix documentation for list return values



commit c4efd6945a8d3ab0dfcfaff03cb4093ee57206ac
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Thu Oct 13 16:17:41 2016 +0100

    geocode-glib: Fix documentation for list return values
    
    The documentation previously said that the return values were (transfer
    container), but they were actually always (transfer full) (and all
    callers in the tests treated them as such). Fix that in the documentation.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=756311

 geocode-glib/geocode-backend.c |   12 ++++++------
 geocode-glib/geocode-forward.c |   12 ++++++------
 2 files changed, 12 insertions(+), 12 deletions(-)
---
diff --git a/geocode-glib/geocode-backend.c b/geocode-glib/geocode-backend.c
index febe33f..9fbf524 100644
--- a/geocode-glib/geocode-backend.c
+++ b/geocode-glib/geocode-backend.c
@@ -84,9 +84,9 @@ geocode_backend_forward_search_async (GeocodeBackend      *backend,
  * Finishes a forward geocoding operation. See
  * geocode_backend_forward_search_async().
  *
- * Returns: (element-type GeocodePlace) (transfer container): A list of
- * places or %NULL in case of errors. Free the returned list with
- * g_list_free() when done.
+ * Returns: (element-type GeocodePlace) (transfer full): A list of
+ * places or %NULL in case of errors. Free the returned instances with
+ * g_object_unref() and the list with g_list_free() when done.
  *
  * Since: UNRELEASED
  */
@@ -120,9 +120,9 @@ geocode_backend_forward_search_finish (GeocodeBackend  *backend,
  * (geocode_backend_forward_search_async()) is more appropriate. See its
  * documentation for more information on usage.
  *
- * Returns: (element-type GeocodePlace) (transfer container): A list of
- * places or %NULL in case of errors. Free the returned list with
- * g_list_free() when done.
+ * Returns: (element-type GeocodePlace) (transfer full): A list of
+ * places or %NULL in case of errors. Free the returned instances with
+ * g_object_unref() and the list with g_list_free() when done.
  *
  * Since: UNRELEASED
  */
diff --git a/geocode-glib/geocode-forward.c b/geocode-glib/geocode-forward.c
index abeb3e6..83d8352 100644
--- a/geocode-glib/geocode-forward.c
+++ b/geocode-glib/geocode-forward.c
@@ -350,9 +350,9 @@ geocode_forward_search_async (GeocodeForward      *forward,
  *
  * Finishes a forward geocoding operation. See geocode_forward_search_async().
  *
- * Returns: (element-type GeocodePlace) (transfer container): A list of
- * places or %NULL in case of errors. Free the returned list with
- * g_list_free() when done.
+ * Returns: (element-type GeocodePlace) (transfer full): A list of
+ * places or %NULL in case of errors. Free the returned instances with
+ * g_object_unref() and the list with g_list_free() when done.
  **/
 GList *
 geocode_forward_search_finish (GeocodeForward       *forward,
@@ -374,9 +374,9 @@ geocode_forward_search_finish (GeocodeForward       *forward,
  * Gets the result of a forward geocoding
  * query using a web service.
  *
- * Returns: (element-type GeocodePlace) (transfer container): A list of
- * places or %NULL in case of errors. Free the returned list with
- * g_list_free() when done.
+ * Returns: (element-type GeocodePlace) (transfer full): A list of
+ * places or %NULL in case of errors. Free the returned instances with
+ * g_object_unref() and the list with g_list_free() when done.
  **/
 GList *
 geocode_forward_search (GeocodeForward      *forward,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]