dovecot: Added comments

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot/rev/35d12c0cd7a7
changeset: 6115:35d12c0cd7a7
user:      Timo Sirainen <tss at iki.fi>
date:      Fri Jul 20 08:31:06 2007 +0300
description:
Added comments

diffstat:

1 file changed, 7 insertions(+)
src/lib-mail/rfc822-parser.h |    7 +++++++

diffs (20 lines):

diff -r 325667778ae3 -r 35d12c0cd7a7 src/lib-mail/rfc822-parser.h
--- a/src/lib-mail/rfc822-parser.h	Fri Jul 20 06:15:20 2007 +0300
+++ b/src/lib-mail/rfc822-parser.h	Fri Jul 20 08:31:06 2007 +0300
@@ -6,9 +6,16 @@ struct rfc822_parser_context {
 	string_t *last_comment;
 };
 
+/* Parse given data using RFC 822 token parser. */
 void rfc822_parser_init(struct rfc822_parser_context *ctx,
 			const unsigned char *data, size_t size,
 			string_t *last_comment);
+
+/* The functions below return 1 = more data available, 0 = no more data
+   available (but a value might have been returned now), -1 = invalid input.
+
+   LWSP is automatically skipped after value, but not before it. So typically
+   you begin with skipping LWSP and then start using the parse functions. */
 
 /* Parse comment. Assumes parser's data points to '(' */
 int rfc822_skip_comment(struct rfc822_parser_context *ctx);