r3553 - trunk/payloads/libpayload/libc

Author: jcrouse
Date: 2008-08-29 01:12:34 +0200 (Fri, 29 Aug 2008)
New Revision: 3553

Modified:
   trunk/payloads/libpayload/libc/time.c
Log:
[PATCH]: libpayload:  Document time functions

No code changes.

Signed-off-by: Jordan Crouse 
Acked-by: Jordan Crouse

Modified: trunk/payloads/libpayload/libc/time.c
===================================================================
--- trunk/payloads/libpayload/libc/time.c	2008-08-28 23:12:22 UTC (rev 3552)
+++ trunk/payloads/libpayload/libc/time.c	2008-08-28 23:12:34 UTC (rev 3553)
@@ -27,6 +27,10 @@
  * SUCH DAMAGE.
  */

+/** @file libc/time.c
+ * @brief General Time Functions
+ */
+
 #include <config.h>
 #include <libpayload.h>
 #include <arch/rdtsc.h>
@@ -110,6 +114,12 @@
 }
 #endif

+/**
+ * Return the current time broken into a timeval structure
+ * @param tv A pointer to a timeval structure
+ * @param tz Added for compatability - not used
+ * @return 0 for success
+ */
 int gettimeofday(struct timeval *tv, void *tz)
 {
    /* Call the gtod init when we need it - this keeps