dovecot-2.0: imap-client.h: Updated comments.

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.0/rev/bd06d9b159fa
changeset: 10661:bd06d9b159fa
user:      Timo Sirainen <tss at iki.fi>
date:      Sun Feb 07 17:37:48 2010 +0200
description:
imap-client.h: Updated comments.

diffstat:

1 file changed, 5 insertions(+), 2 deletions(-)
src/imap/imap-client.h |    7 +++++--

diffs (19 lines):

diff -r 56b1d4dd9c7d -r bd06d9b159fa src/imap/imap-client.h
--- a/src/imap/imap-client.h	Sun Feb 07 17:30:24 2010 +0200
+++ b/src/imap/imap-client.h	Sun Feb 07 17:37:48 2010 +0200
@@ -164,10 +164,13 @@ void client_disconnect_with_error(struct
 /* Send a line of data to client. Returns 1 if ok, 0 if buffer is getting full,
    -1 if error */
 int client_send_line(struct client *client, const char *data);
-/* Send line of data to client, prefixed with client->tag */
+/* Send line of data to client, prefixed with client->tag. You need to prefix
+   the data with "OK ", "NO " or "BAD ". */
 void client_send_tagline(struct client_command_context *cmd, const char *data);
 
-/* Send BAD command error to client. msg can be NULL. */
+/* Send a BAD command reply to client via client_send_tagline(). If there have
+   been too many command errors, the client is disconnected. msg may be NULL,
+   in which case the error is looked up from imap_parser. */
 void client_send_command_error(struct client_command_context *cmd,
 			       const char *msg);