diff options
| author | Jonny Lamb <jonny.lamb@collabora.co.uk> | 2011-11-04 18:58:14 +0000 |
|---|---|---|
| committer | Jonny Lamb <jonny.lamb@collabora.co.uk> | 2011-11-11 10:50:52 +0000 |
| commit | 9d78454128de6c3f808b0b230b37455e84605bb5 (patch) | |
| tree | 72572aaccbc498a0890d584441af66ba2fef488e /telepathy-glib/file-transfer-channel.c | |
| parent | ea6a2cbba50851f041603933be199461137a35a7 (diff) | |
| download | telepathy-glib-9d78454128de6c3f808b0b230b37455e84605bb5.tar.gz | |
ft-channel: more misc. fixes to docs
Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
Diffstat (limited to 'telepathy-glib/file-transfer-channel.c')
| -rw-r--r-- | telepathy-glib/file-transfer-channel.c | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/telepathy-glib/file-transfer-channel.c b/telepathy-glib/file-transfer-channel.c index de74ac1bf..3624cfe25 100644 --- a/telepathy-glib/file-transfer-channel.c +++ b/telepathy-glib/file-transfer-channel.c @@ -1094,12 +1094,13 @@ file_replace_async_cb (GObject *source, /** * tp_file_transfer_channel_accept_file_async: * @self: a #TpFileTransferChannel - * @file: a #GFile + * @file: a #GFile where the file should be saved * @offset: Offset from the start of @file where transfer begins * @callback: a callback to call when the transfer has been accepted * @user_data: data to pass to @callback * - * Accept an incoming file transfer. Once the accept has been + * Accept an incoming file transfer in the + * %TP_FILE_TRANSFER_STATE_PENDING state. Once the accept has been * processed, @callback will be called. You can then call * tp_file_transfer_channel_accept_file_finish() to get the result of * the operation. @@ -1158,7 +1159,7 @@ tp_file_transfer_channel_accept_file_async (TpFileTransferChannel *self, * @result: a #GAsyncResult * @error: a #GError to fill * - * Finishes a file transfer accept. + * Finishes a file transfer accept operation. * * Returns: %TRUE if the accept operation was a success, or %FALSE * @@ -1212,7 +1213,7 @@ file_read_async_cb (GObject *source, /** * tp_file_transfer_channel_provide_file_async: * @self: a #TpFileTransferChannel - * @file: a #GFile + * @file: a #GFile to send to the remote contact * @callback: a callback to call when the transfer has been accepted * @user_data: data to pass to @callback * @@ -1284,8 +1285,7 @@ tp_file_transfer_channel_provide_file_async (TpFileTransferChannel *self, * * Successful return from this function does not mean that the file * transfer has completed or has even started at all. The state of the - * file transfer should be monitored with - * #TpFileTransferChannel::notify::state. + * file transfer should be monitored with the "notify::state" signal. * * Returns: %TRUE if the file has been successfully provided, or * %FALSE. @@ -1403,6 +1403,8 @@ tp_file_transfer_channel_get_size (TpFileTransferChannel *self) * @self: a #TpFileTransferChannel * @reason: (out): a #TpFileTransferStateChangeReason, or %NULL * + * Returns the #TpFileTransfer:state property. + * * If @reason is not %NULL it is set to the reason why * #TpFileTransferChannel:state changed to its current value. * |