plugin: clarify the return type of CreateChannelManagersImpl

Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>

1 files changed, 3 insertions, 0 deletions

diff --git a/salut/plugin.h b/salut/plugin.h
index c833ac42..88d716b1 100644
--- a/salut/plugin.h
+++ b/salut/plugin.h
@@ -39,6 +39,9 @@ G_BEGIN_DECLS
 typedef struct _SalutPlugin SalutPlugin;
 typedef struct _SalutPluginInterface SalutPluginInterface;
 
+/* The return type should be a new GPtrArray* which will be freed
+ * straight after this function is called, so the pointer array must
+ * not have a free function. */
 typedef GPtrArray * (*SalutPluginCreateChannelManagersImpl) (
     SalutPlugin *plugin,
     TpBaseConnection *connection);