dovecot-2.2: lib-mail: Added comments to message-parser.h

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/051a96b3960f
changeset: 17693:051a96b3960f
user:      Timo Sirainen <tss at iki.fi>
date:      Mon Aug 11 13:32:06 2014 +0300
description:
lib-mail: Added comments to message-parser.h

diffstat:

 src/lib-mail/message-parser.h |  5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)

diffs (15 lines):

diff -r f41d3c771627 -r 051a96b3960f src/lib-mail/message-parser.h
--- a/src/lib-mail/message-parser.h	Mon Aug 11 13:30:25 2014 +0300
+++ b/src/lib-mail/message-parser.h	Mon Aug 11 13:32:06 2014 +0300
@@ -26,7 +26,10 @@
 	/* non-NULL if a header line was read */
 	struct message_header_line *hdr;
 
-	/* hdr = NULL, size = 0 block returned at the end of headers */
+	/* hdr = NULL, size = 0 block returned at the end of headers for the
+	   empty line between header and body (unless the header is truncated).
+	   Later on data and size>0 is returned for blocks of mail body that
+	   is read (see message_parser_flags for what is actually returned) */
 	const unsigned char *data;
 	size_t size;
 };