[dovecot-cvs] dovecot: Fixed comments.

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot/rev/d6a86d6367fe
changeset: 5701:d6a86d6367fe
user:      Timo Sirainen <tss at iki.fi>
date:      Tue Jun 12 18:06:38 2007 +0300
description:
Fixed comments.

diffstat:

1 file changed, 6 insertions(+), 6 deletions(-)
src/lib-imap/imap-date.h |   12 ++++++------

diffs (23 lines):

diff -r bbd2b811d3e6 -r d6a86d6367fe src/lib-imap/imap-date.h
--- a/src/lib-imap/imap-date.h	Tue Jun 12 18:03:37 2007 +0300
+++ b/src/lib-imap/imap-date.h	Tue Jun 12 18:06:38 2007 +0300
@@ -1,13 +1,13 @@
 #ifndef __IMAP_DATE_H
 #define __IMAP_DATE_H
 
-/* Parses IMAP date/time string. time_t is filled with UTC date.
-   timezone_offset is filled with parsed timezone. If no timezone is given,
-   local timezone is assumed.
+/* Parses IMAP date/time string and returns TRUE if the string is valid.
+   time_t is filled with UTC date. timezone_offset is filled with parsed
+   timezone. If no timezone is given, local timezone is assumed.
 
-   Returns TRUE if string is valid. If date is outside valid range for time_t
-   (usually only with 32bit time_t), the function still return TRUE but
-   returned time is (time_t)-1. */
+   If date is too low or too high to fit to time_t, it's set to lowest/highest
+   allowed value. This allows you to use the value directly for comparing
+   timestamps. */
 bool imap_parse_date(const char *str, time_t *time);
 bool imap_parse_datetime(const char *str, time_t *time, int *timezone_offset);