diff options
| author | Will Thompson <will.thompson@collabora.co.uk> | 2011-10-04 00:24:40 +0100 |
|---|---|---|
| committer | Will Thompson <will.thompson@collabora.co.uk> | 2011-11-04 09:02:11 +0000 |
| commit | eb0dc2a0694451453c40c0e75da3ba9093837339 (patch) | |
| tree | c2bbb5de7534cd8300731ba9b76c673f784ff6d9 | |
| parent | 933af070afdc7a3a1df333c318743e0ba115f3a5 (diff) | |
Document _gabble_im_channel_receive usefully
| -rw-r--r-- | src/im-channel.c | 22 |
1 files 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 <message/> 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, |