dovecot-2.2: lib-storage: API comment update

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/63a9b750027b
changeset: 16957:63a9b750027b
user:      Timo Sirainen <tss at iki.fi>
date:      Sat Nov 16 19:35:10 2013 +0200
description:
lib-storage: API comment update

diffstat:

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

diffs (15 lines):

diff -r 03bf99704fe5 -r 63a9b750027b src/lib-storage/mail-storage.h
--- a/src/lib-storage/mail-storage.h	Sat Nov 16 19:34:57 2013 +0200
+++ b/src/lib-storage/mail-storage.h	Sat Nov 16 19:35:10 2013 +0200
@@ -870,7 +870,10 @@
    Do not use for structured fields (see mail_get_first_header_utf8()). */
 int mail_get_headers_utf8(struct mail *mail, const char *field,
 			  const char *const **value_r);
-/* Returns stream containing specified headers. */
+/* Returns stream containing specified headers. The returned stream will be
+   automatically freed when the mail is closed, or when another
+   mail_get_header_stream() call is made (so you can't have multiple header
+   streams open at the same time). */
 int mail_get_header_stream(struct mail *mail,
 			   struct mailbox_header_lookup_ctx *headers,
 			   struct istream **stream_r);