[GNUnet-SVN] r29950 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2013-10-08 08:47:12 +0200 (Tue, 08 Oct 2013)
New Revision: 29950

Modified:
   gnunet/src/include/gnunet_strings_lib.h
Log:
-document UTC vs local time

Modified: gnunet/src/include/gnunet_strings_lib.h
===================================================================
--- gnunet/src/include/gnunet_strings_lib.h     2013-10-07 22:12:36 UTC (rev 
29949)
+++ gnunet/src/include/gnunet_strings_lib.h     2013-10-08 06:47:12 UTC (rev 
29950)
@@ -77,11 +77,12 @@
 
 /**
  * Convert a given fancy human-readable time to our internal
- * representation.
+ * representation.  The human-readable time is expected to be
+ * in local time, whereas the returned value will be in UTC.
  *
  * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S)
  * @param atime set to the absolute time
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
 int
 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
@@ -223,12 +224,13 @@
 
 
 /**
- * "asctime", except for GNUnet time.
+ * "asctime", except for GNUnet time.  Converts a GNUnet internal
+ * absolute time (which is in UTC) to a string in local time.
  * This is one of the very few calls in the entire API that is
  * NOT reentrant!
  *
  * @param t the absolute time to convert
- * @return timestamp in human-readable form
+ * @return timestamp in human-readable form in local time
  */
 const char *
 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);