diff options
author | Will Thompson <will.thompson@collabora.co.uk> | 2012-03-26 17:13:06 +0100 |
---|---|---|
committer | Will Thompson <will.thompson@collabora.co.uk> | 2012-03-26 17:15:57 +0100 |
commit | 7cfb90e3dfac54456423c0a27ba0f39b512f6997 (patch) | |
tree | dd9dbf8a40caafb6c8d1310e292d63aa76b83a12 | |
parent | 75d92d599cde42d24d487c12ba3170a300db4311 (diff) | |
download | telepathy-glib-7cfb90e3dfac54456423c0a27ba0f39b512f6997.tar.gz |
docs: Fix "Finishes to" broken English
-rw-r--r-- | telepathy-glib/channel.c | 24 | ||||
-rw-r--r-- | telepathy-glib/stream-tube-channel.c | 4 | ||||
-rw-r--r-- | telepathy-glib/text-channel.c | 21 |
3 files changed, 26 insertions, 23 deletions
diff --git a/telepathy-glib/channel.c b/telepathy-glib/channel.c index 4136d8259..3417b9203 100644 --- a/telepathy-glib/channel.c +++ b/telepathy-glib/channel.c @@ -2451,12 +2451,12 @@ tp_channel_join_async (TpChannel *self, /** * tp_channel_join_finish: * @self: a #TpChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_channel_join_async(). * @error: a #GError to fill * - * Finishes to join a channel. + * Completes a call to tp_channel_join_async(). * - * Returns: %TRUE if the channel has been joined; %FALSE otherwise + * Returns: %TRUE if the channel was successfully joined; %FALSE otherwise * * Since: 0.15.5 */ @@ -2659,10 +2659,10 @@ tp_channel_leave_async (TpChannel *self, /** * tp_channel_leave_finish: * @self: a #TpChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_channel_leave_async(). * @error: a #GError to fill * - * Finishes to leave a channel. + * Completes a call to tp_channel_leave_async(). * * Returns: %TRUE if the channel has been left; %FALSE otherwise * @@ -2716,10 +2716,10 @@ tp_channel_close_async (TpChannel *self, /** * tp_channel_close_finish: * @self: a #TpChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_channel_close_async(). * @error: a #GError to fill * - * Finishes to close a channel. + * Finishes a call to tp_channel_leave_async(). * * Returns: %TRUE if the channel has been closed; %FALSE otherwise * @@ -2801,10 +2801,10 @@ tp_channel_destroy_async (TpChannel *self, /** * tp_channel_destroy_finish: * @self: a #TpChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_channel_destroy_async(). * @error: a #GError to fill * - * Finishes to leave a channel. + * Completes a call to tp_channel_destroy_async(). * * Returns: %TRUE if the channel has been destroyed or closed; %FALSE otherwise * @@ -2917,10 +2917,12 @@ tp_channel_provide_password_async (TpChannel *self, /** * tp_channel_provide_password_finish: * @self: a #TpChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for + * tp_channel_provide_password_async(). * @error: a #GError to fill * - * Finishes to provide a password. If the password was rejected, the operation + * Completes a call to tp_channel_provide_password_async(). + * If the password was rejected, the operation * fails with #TP_ERROR_AUTHENTICATION_FAILED. * * Returns: %TRUE if the password has been provided and accepted, diff --git a/telepathy-glib/stream-tube-channel.c b/telepathy-glib/stream-tube-channel.c index 94bb23d1d..9b33a7530 100644 --- a/telepathy-glib/stream-tube-channel.c +++ b/telepathy-glib/stream-tube-channel.c @@ -919,7 +919,7 @@ tp_stream_tube_channel_accept_async (TpStreamTubeChannel *self, * @result: a #GAsyncResult * @error: a #GError to fill * - * Finishes to accept an incoming stream tube. The returned + * Finishes accepting an incoming stream tube. The returned * #TpStreamTubeConnection can then be used to exchange data through the tube. * * Returns: (transfer full): a newly created #TpStreamTubeConnection @@ -1493,7 +1493,7 @@ tp_stream_tube_channel_offer_async (TpStreamTubeChannel *self, * @result: a #GAsyncResult * @error: a #GError to fill * - * Finishes to offer an outgoing stream tube. + * Finishes offering an outgoing stream tube. * * Returns: %TRUE when a Tube has been successfully offered; %FALSE otherwise * diff --git a/telepathy-glib/text-channel.c b/telepathy-glib/text-channel.c index cc7052d16..46798b88f 100644 --- a/telepathy-glib/text-channel.c +++ b/telepathy-glib/text-channel.c @@ -1254,16 +1254,17 @@ tp_text_channel_send_message_async (TpTextChannel *self, /** * tp_text_channel_send_message_finish: * @self: a #TpTextChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_text_channel_send_message_async() * @token: (out) (transfer full): if not %NULL, used to return the * token of the sent message * @error: a #GError to fill * - * Finishes to send a message. + * Completes a call to tp_text_channel_send_message_async(). * * @token can be used to match any incoming delivery or failure reports - * against the sent message. If the returned token is %NULL the - * message is not readily identifiable. + * against the sent message. If this function returns true but the returned + * token is %NULL, the message was sent successfully but the protocol does not + * provide a way to identify it later. * * Returns: %TRUE if the message has been submitted to the server, %FALSE * otherwise. @@ -1395,10 +1396,10 @@ tp_text_channel_ack_messages_async (TpTextChannel *self, /** * tp_text_channel_ack_messages_finish: * @self: a #TpTextChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_text_channel_ack_messages_async() * @error: a #GError to fill * - * Finishes to ack a list of messages. + * Finishes acknowledging a list of messages. * * Returns: %TRUE if the messages have been acked, %FALSE otherwise. * @@ -1476,10 +1477,10 @@ tp_text_channel_ack_message_async (TpTextChannel *self, /** * tp_text_channel_ack_message_finish: * @self: a #TpTextChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_text_channel_ack_message_async() * @error: a #GError to fill * - * Finishes to ack a message. + * Finishes acknowledging a message. * * Returns: %TRUE if the message has been acked, %FALSE otherwise. * @@ -1544,10 +1545,10 @@ tp_text_channel_set_chat_state_async (TpTextChannel *self, /** * tp_text_channel_set_chat_state_finish: * @self: a #TpTextChannel - * @result: a #GAsyncResult + * @result: a #GAsyncResult passed to the callback for tp_text_channel_set_chat_state_async() * @error: a #GError to fill * - * Finishes to set chat state. + * Completes a call to tp_text_channel_set_chat_state_async(). * * Returns: %TRUE if the chat state has been changed, %FALSE otherwise. * |