[evolution-data-server/imapx-extensible: 6/10] CamelIMAPXServer: added documentation for untagged handler descriptor struct

[Christian Hilberg <chilberg src gnome org>]

commit ecf47a227d77e0cd1f1abf8ca407b49ffa6f67fa
Author: Christian Hilberg <chilberg src gnome org>
Date:   Thu Jun 14 19:11:22 2012 +0200

    CamelIMAPXServer: added documentation for untagged handler descriptor struct

 camel/camel-imapx-server.h |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)
---
diff --git a/camel/camel-imapx-server.h b/camel/camel-imapx-server.h
index 12ba7fd..809e9b0 100644
--- a/camel/camel-imapx-server.h
+++ b/camel/camel-imapx-server.h
@@ -65,6 +65,25 @@ struct _IMAPXJobQueueInfo;
 typedef gboolean (*CamelIMAPXUntaggedRespHandler) (CamelIMAPXServer *server,
                                                    GCancellable *cancellable,
                                                    GError **error);
+
+/**
+ * CamelIMAPXUntaggedRespHandlerDesc:
+ * @handler: an untagged response handler function for #CamelIMAPXServer
+ * @next_response: the IMAP untagged code to call a registered
+ *                 handler for directly after successfully
+ *                 running @handler. If not NULL, @skip_stream_when_done
+ *                 for the current handler has no effect
+ * @skip_stream_when_done: whether or not to skip the current IMAP
+ *                         untagged response in the #CamelIMAPXStream.
+ *                         Set to TRUE if your handler does not eat
+ *                         the stream up to the next response token
+ *
+ * IMAP untagged response handler function descriptor. Use in conjunction
+ * with camel_imapx_server_register_untagged_handler() to register a new
+ * handler function for a given untagged response code
+ *
+ * Since: 3.6
+ */
 typedef struct _CamelIMAPXUntaggedRespHandlerDesc CamelIMAPXUntaggedRespHandlerDesc;
 struct _CamelIMAPXUntaggedRespHandlerDesc {
 	const CamelIMAPXUntaggedRespHandler handler;