Attachment 65219 Details for Bug 53198 – trivial: remove free function links from documentation

[patch] trivial: remove free function links from documentation

0002-trivial-remove-free-function-links-from-documentatio.patch (text/plain), 3.07 KB, created by Evan Nemerson on 2012-08-07 06:22:21 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Evan Nemerson

Created: 2012-08-07 06:22:21 UTC

Size: 3.07 KB

patch

obsolete

>From fe0d65ed202b663658ccff644a7dabe236eef396 Mon Sep 17 00:00:00 2001
>From: Evan Nemerson <evan@coeus-group.com>
>Date: Mon, 6 Aug 2012 23:16:04 -0700
>Subject: [PATCH 2/2] trivial: remove free function links from documentation
>
>These notes are confusing for people trying to read documentation
>generated for languages which manage memory, such as Vala, JavaScript,
>and Python.
>---
> libcolord/cd-client-sync.c | 8 ++++----
> libcolord/cd-device.c      | 2 +-
> libcolord/cd-profile.c     | 2 +-
> libcolord/cd-sensor.c      | 2 +-
> 4 files changed, 7 insertions(+), 7 deletions(-)
>
>diff --git a/libcolord/cd-client-sync.c b/libcolord/cd-client-sync.c
>index eabbc06..d73b346 100644
>--- a/libcolord/cd-client-sync.c
>+++ b/libcolord/cd-client-sync.c
>@@ -502,7 +502,7 @@ cd_client_get_devices_finish_sync (CdClient *client,
>  * Do not use it in GUI applications.
>  *
>  * Return value: (transfer full) (element-type CdDevice): an array of
>- *		 #CdDevice objects, free with g_ptr_array_unref()
>+ *		 #CdDevice objects.
>  *
>  * Since: 0.1.0
>  **/
>@@ -555,7 +555,7 @@ cd_client_get_profiles_finish_sync (CdClient *client,
>  * Do not use it in GUI applications.
>  *
>  * Return value: (transfer full) (element-type CdProfile): an array of
>- *		 #CdProfile objects, free with g_ptr_array_unref()
>+ *		 #CdProfile objects.
>  *
>  * Since: 0.1.0
>  **/
>@@ -608,7 +608,7 @@ cd_client_get_sensors_finish_sync (CdClient *client,
>  * Do not use it in GUI applications.
>  *
>  * Return value: (transfer full) (element-type CdSensor): an array of
>- *		 #CdSensor objects, free with g_ptr_array_unref()
>+ *		 #CdSensor objects.
>  *
>  * Since: 0.1.0
>  **/
>@@ -824,7 +824,7 @@ cd_client_get_devices_by_kind_finish_sync (CdClient *client,
>  * Do not use it in GUI applications.
>  *
>  * Return value: (transfer full) (element-type CdDevice): an array of
>- *		 #CdDevice objects, free with g_ptr_array_unref()
>+ *		 #CdDevice objects.
>  *
>  * Since: 0.1.0
>  **/
>diff --git a/libcolord/cd-device.c b/libcolord/cd-device.c
>index 2d2e43f..9e40c1f 100644
>--- a/libcolord/cd-device.c
>+++ b/libcolord/cd-device.c
>@@ -447,7 +447,7 @@ out:
>  * Returns the device metadata.
>  *
>  * Return value: (transfer full) (element-type utf8 utf8): a
>- *               #GHashTable, free with g_hash_table_unref().
>+ *               #GHashTable.
>  *
>  * Since: 0.1.5
>  **/
>diff --git a/libcolord/cd-profile.c b/libcolord/cd-profile.c
>index 5b6f791..f44e900 100644
>--- a/libcolord/cd-profile.c
>+++ b/libcolord/cd-profile.c
>@@ -406,7 +406,7 @@ cd_profile_get_is_system_wide (CdProfile *profile)
>  * Returns the profile metadata.
>  *
>  * Return value: (transfer full) (element-type utf8 utf8): a
>- *               #GHashTable, free with g_hash_table_unref().
>+ *               #GHashTable.
>  *
>  * Since: 0.1.2
>  **/
>diff --git a/libcolord/cd-sensor.c b/libcolord/cd-sensor.c
>index f2cdc60..4dcacb0 100644
>--- a/libcolord/cd-sensor.c
>+++ b/libcolord/cd-sensor.c
>@@ -275,7 +275,7 @@ cd_sensor_get_locked (CdSensor *sensor)
>  *
>  * Returns the sensor metadata.
>  *
>- * Return value: a #GHashTable, free with g_hash_table_unref().
>+ * Return value: a #GHashTable.
>  *
>  * Since: 0.1.6
>  **/
>-- 
>1.7.11.2
>

Actions: View | Splinter Review

Attachments on bug 53198: 65218 | 65219

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.