Various Doxygen-related fixes in libpayload (trivial).
authorUwe Hermann <uwe@hermann-uwe.de>
Sun, 31 Aug 2008 22:10:35 +0000 (22:10 +0000)
committerUwe Hermann <uwe@hermann-uwe.de>
Sun, 31 Aug 2008 22:10:35 +0000 (22:10 +0000)
commit3153863567f51c9173227b9cb4375d53e6f3e6ed
tree3502c7fa5c991c73d2b2fe669ebf3411ef08f10d
parent0e6ad6bd09594924f6f7224bc14b27f9c4e8429c
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
payloads/libpayload/i386/timer.c
payloads/libpayload/include/libpayload.h
payloads/libpayload/libc/readline.c
payloads/libpayload/libc/time.c