diff options
| author | Uwe Hermann <uwe@hermann-uwe.de> | 2008-08-31 22:10:35 +0000 |
|---|---|---|
| committer | Uwe Hermann <uwe@hermann-uwe.de> | 2008-08-31 22:10:35 +0000 |
| commit | 3153863567f51c9173227b9cb4375d53e6f3e6ed (patch) | |
| tree | 3502c7fa5c991c73d2b2fe669ebf3411ef08f10d /payloads/libpayload/libc/time.c | |
| parent | 0e6ad6bd09594924f6f7224bc14b27f9c4e8429c (diff) | |
| download | coreboot-3153863567f51c9173227b9cb4375d53e6f3e6ed.tar.gz coreboot-3153863567f51c9173227b9cb4375d53e6f3e6ed.tar.bz2 coreboot-3153863567f51c9173227b9cb4375d53e6f3e6ed.zip | |
Various Doxygen-related fixes in libpayload (trivial).
- Drop all '@brief's, they're not needed as we use JAVADOC_AUTOBRIEF.
The first sentence of every description will be treated as the '@brief'
automatically.
- Also, put all documentation/descriptions on top of the Doxygen-comments,
and put the '@foo' keywords at the bottom of the comments for consistency.
- Change comments for SEEK_SET/SEEK_CUR/SEEK_END from '/**@def' to '/**<'
in order to make them appear in the output.
- Drop all explicit '@struct' lines (which are optional; Doxygen will figure
out that it's a struct if the comment is right before the struct).
- Fix various typos, whitespace issues, etc.
- Fix incorrect @param variable names, e.g. change '@param n foobar' to
'@param s foobar' if the variable is named 's'.
Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>
Acked-by: Uwe Hermann <uwe@hermann-uwe.de>
git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3555 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
Diffstat (limited to 'payloads/libpayload/libc/time.c')
| -rw-r--r-- | payloads/libpayload/libc/time.c | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/payloads/libpayload/libc/time.c b/payloads/libpayload/libc/time.c index b49879b9d81d..b47e452e49dc 100644 --- a/payloads/libpayload/libc/time.c +++ b/payloads/libpayload/libc/time.c @@ -27,8 +27,9 @@ * SUCH DAMAGE. */ -/** @file libc/time.c - * @brief General Time Functions +/** + * @file libc/time.c + * General time functions */ #include <config.h> @@ -115,18 +116,18 @@ static void gettimeofday_init(void) #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 + * 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 (this function cannot return non-zero currently). */ int gettimeofday(struct timeval *tv, void *tz) { - /* Call the gtod init when we need it - this keeps - the code from being included in the binary if we don't - need it - */ - + /* + * Call the gtod init when we need it - this keeps the code from + * being included in the binary if we don't need it. + */ if (!clock.ticks) gettimeofday_init(); |