From eb0dc2a0694451453c40c0e75da3ba9093837339 Mon Sep 17 00:00:00 2001 From: Will Thompson Date: Tue, 4 Oct 2011 00:24:40 +0100 Subject: Document _gabble_im_channel_receive usefully --- src/im-channel.c | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/src/im-channel.c b/src/im-channel.c index 40b3a368f..f335c9848 100644 --- a/src/im-channel.c +++ b/src/im-channel.c @@ -384,9 +384,27 @@ _gabble_im_channel_send_message (GObject *object, priv->send_nick = FALSE; } -/** - * _gabble_im_channel_receive +/* + * _gabble_im_channel_receive: + * @chan: a channel + * @type: the message type + * @sender: the sender of the message (which may not be 0) + * @from: the full JID we received the message from + * @timestamp: the time at which the message was sent (not the time it was + * received) + * @id: the id='' attribute from the stanza, if any + * @text: the plaintext body of the message + * @send_error: the reason why sending @text to @sender failed, or + * GABBLE_TEXT_CHANNEL_SEND_NO_ERROR if this call is not to report + * a failure to send. + * @delivery_status: if @send_error is GABBLE_TEXT_CHANNEL_SEND_NO_ERROR, + * ignored; else the delivery status to attach to the report. + * @state: a #TpChannelChatState, or -1 if there was no chat state in the + * message. * + * Shoves an incoming message into @chan, possibly updating the chat state at + * the same time; or maybe this is a delivery report? Who knows! It's a magical + * adventure. */ void _gabble_im_channel_receive (GabbleIMChannel *chan, -- cgit v1.2.3