[evolution-data-server] Camel: Clarify ownership of returned CamelProviders.
- From: Matthew Barnes <mbarnes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] Camel: Clarify ownership of returned CamelProviders.
- Date: Tue, 17 Jan 2012 17:34:26 +0000 (UTC)
commit 116eb4aa0f4c2b02d371da93e1954f0d323ccecf
Author: Matthew Barnes <mbarnes redhat com>
Date: Tue Jan 17 12:34:07 2012 -0500
Camel: Clarify ownership of returned CamelProviders.
camel/camel-provider.c | 8 +++++++-
1 files changed, 7 insertions(+), 1 deletions(-)
---
diff --git a/camel/camel-provider.c b/camel/camel-provider.c
index 9beaaf0..43e5035 100644
--- a/camel/camel-provider.c
+++ b/camel/camel-provider.c
@@ -312,7 +312,10 @@ add_to_list (gpointer key,
* is %TRUE, it will first load in all available providers that haven't
* yet been loaded.
*
- * Returns: a GList of providers, which the caller must free.
+ * Free the returned list with g_list_free(). The #CamelProvider structs
+ * in the list are owned by Camel and should not be modified or freed.
+ *
+ * Returns: a #GList of #CamelProvider structs
**/
GList *
camel_provider_list (gboolean load)
@@ -362,6 +365,9 @@ camel_provider_list (gboolean load)
* @protocol, or the provider module fails to load, the function
* sets @error and returns %NULL.
*
+ * The returned #CamelProvider is owned by Camel and should not be
+ * modified or freed.
+ *
* Returns: a #CamelProvider for %protocol, or %NULL
**/
CamelProvider *
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]