[Telepathy-commits] [telepathy-glib/master] Clarify tp_connection_manager_new's arguments.

Will Thompson will.thompson at collabora.co.uk
Wed Jan 7 04:30:00 PST 2009


Fixes fd.o #18146
---
 telepathy-glib/connection-manager.c |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/telepathy-glib/connection-manager.c b/telepathy-glib/connection-manager.c
index 3dfa490..18dbe45 100644
--- a/telepathy-glib/connection-manager.c
+++ b/telepathy-glib/connection-manager.c
@@ -1165,13 +1165,15 @@ tp_connection_manager_class_init (TpConnectionManagerClass *klass)
 /**
  * tp_connection_manager_new:
  * @dbus: Proxy for the D-Bus daemon
- * @name: The connection manager name
- * @manager_filename: The #TpConnectionManager:manager-file property
+ * @name: The connection manager name (such as "gabble")
+ * @manager_filename: The #TpConnectionManager:manager-file property, which may
+ *                    (and generally should) be %NULL.
  * @error: used to return an error if %NULL is returned
  *
  * Convenience function to create a new connection manager proxy.
  *
- * Returns: a new reference to a connection manager proxy
+ * Returns: a new reference to a connection manager proxy, or %NULL if @error
+ *          is set.
  */
 TpConnectionManager *
 tp_connection_manager_new (TpDBusDaemon *dbus,
-- 
1.5.6.5




More information about the Telepathy-commits mailing list