Document TpChannelWhenReadyCb

20080502112247-53eee-d675b2fdbe9fda331b07719f8eb94e851e49fa61.gz

1 files changed, 14 insertions, 0 deletions

diff --git a/telepathy-glib/channel.c b/telepathy-glib/channel.c
index 0ac209a20..bcef95a0b 100644
--- a/telepathy-glib/channel.c
+++ b/telepathy-glib/channel.c
@@ -723,6 +723,20 @@ cwr_ready (TpChannel *self,
 }
 
 /**
+ * TpChannelWhenReadyCb:
+ * @channel: the channel (which may be in the middle of being disposed,
+ *  if error is non-%NULL, error->domain is TP_DBUS_ERRORS and error->code is
+ *  TP_DBUS_ERROR_PROXY_UNREFERENCED)
+ * @error: %NULL if the channel is ready for use, or the error with which
+ *  it was invalidated if it is now invalid
+ * @user_data: whatever was passed to tp_channel_call_when_ready()
+ *
+ * Signature of a callback passed to tp_channel_call_when_ready(), which
+ * will be called exactly once, when the channel becomes ready or
+ * invalid (whichever happens first)
+ */
+
+/**
  * tp_channel_call_when_ready:
  * @self: a channel
  * @callback: called when the channel becomes ready or invalidated, whichever