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

1 files changed, 16 insertions, 13 deletions

diff --git a/payloads/libpayload/i386/timer.c b/payloads/libpayload/i386/timer.c
index 46d21cc6ae..e1a886e302 100644
--- a/payloads/libpayload/i386/timer.c
+++ b/payloads/libpayload/i386/timer.c
@@ -27,8 +27,9 @@
  * SUCH DAMAGE.
  */
 
-/** @file i386/timer.c
- * @brief i386 specific timer routines
+/**
+ * @file i386/timer.c
+ * i386 specific timer routines
  */
 
 #include <libpayload.h>
@@ -36,7 +37,7 @@
 
 /**
  * @ingroup arch
- * Global variable containing the speed of the processor in KHz
+ * Global variable containing the speed of the processor in KHz.
  */
 u32 cpu_khz;
 
@@ -81,8 +82,9 @@ static inline void _delay(unsigned int delta)
 }
 
 /**
- * Delay for a specified number of nanoseconds
- * @param n Number of nanoseconds to delay for
+ * Delay for a specified number of nanoseconds.
+ *
+ * @param n Number of nanoseconds to delay for.
  */
 void ndelay(unsigned int n)
 {
@@ -90,8 +92,9 @@ void ndelay(unsigned int n)
 }
 
 /**
- * Delay for a specified number of microseconds
- * @param n Number of microseconds to delay for
+ * Delay for a specified number of microseconds.
+ *
+ * @param n Number of microseconds to delay for.
  */
 void udelay(unsigned int n)
 {
@@ -99,20 +102,20 @@ void udelay(unsigned int n)
 }
 
 /**
- * Delay for a specified number of milliseconds
- * @param n Number of milliseconds to delay for
+ * Delay for a specified number of milliseconds.
+ *
+ * @param m Number of milliseconds to delay for.
  */
-
 void mdelay(unsigned int m)
 {
 	_delay(m * cpu_khz);
 }
 
 /**
- * Delay for a specified number of seconds
- * @param n Number of seconds to delay for
+ * Delay for a specified number of seconds.
+ *
+ * @param s Number of seconds to delay for.
  */
-
 void delay(unsigned int s)
 {
 	_delay(s * cpu_khz * 1000);