/soc/2013/ankitkv/gobjectification: e769bd450874: Add a note in ...

[Ankit Vani]

Changeset: e769bd45087418620bec7785977cb0e4f88c63ff
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-08-07 04:54 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/e769bd450874

Description:

Add a note in the documentation for purple_plugins_find_all() that the list is owned by caller

diffstat:

 libpurple/plugins.h |  3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diffs (13 lines):

diff --git a/libpurple/plugins.h b/libpurple/plugins.h
--- a/libpurple/plugins.h
+++ b/libpurple/plugins.h
@@ -523,7 +523,8 @@ GType purple_plugin_action_get_type(void
 /**
  * Returns a list of all plugins, whether loaded or not.
  *
- * @return A list of all plugins.
+ * @return A list of all plugins. The list is owned by the caller, and must be
+ *         g_list_free()d to avoid leaking the nodes.
  */
 GList *purple_plugins_find_all(void);