Commit c4efd694 authored by Philip Withnall's avatar Philip Withnall Committed by Philip Withnall
Browse files

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
parent 6e8d348b
......@@ -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
*/
......
......@@ -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,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment