Fix some Doxygen warnings and/or typos (trivial).

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@3538 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

diff --git a/payloads/libpayload/libc/exec.c b/payloads/libpayload/libc/exec.c
index ab0eb6422209a337f1d7b5af66efb53e930d7abc..e0fea8b291ce693e7e3572b874738597ab6ca5d6 100644 (file)
--- a/payloads/libpayload/libc/exec.c
+++ b/payloads/libpayload/libc/exec.c
@@ -35,10 +35,12 @@ extern void i386_do_exec(long addr, int argc, char **argv, int *ret);
 #endif
 
 /**
- * Execute code in memory
+ * Execute code in memory.
  *
- * @param ptr The entry point to jump to
- * @return Return the return value from the entry point
+ * @param addr TODO
+ * @param argc TODO
+ * @param argv TODO
+ * @return Return the return value from the entry point.
  */
 int exec(long addr, int argc, char **argv)
 {

diff --git a/payloads/libpayload/libc/lib.c b/payloads/libpayload/libc/lib.c
index 3f82acf3786f876b774e2195206873063cc758de..3666265d36466ab0223d92c87747675339e62b10 100644 (file)
--- a/payloads/libpayload/libc/lib.c
+++ b/payloads/libpayload/libc/lib.c
@@ -54,7 +54,7 @@ int dec2bcd(int d)
 /**
  * Return the absolute value of the specified integer.
  *
- * @param val The integer of which we want to know the absolute value.
+ * @param j The integer of which we want to know the absolute value.
  * @return The absolute value of the specified integer.
  */
 int abs(int j)

diff --git a/payloads/libpayload/libc/printf.c b/payloads/libpayload/libc/printf.c
index 6972636b2365a4c817ce516b6840f57cc18e8e94..3973e90f22b48ed7eedf2f9fac579c4d9b7cb90e 100644 (file)
--- a/payloads/libpayload/libc/printf.c
+++ b/payloads/libpayload/libc/printf.c
@@ -135,6 +135,7 @@ static int printf_putchar(int c, struct printf_spec *ps)
  * @param c    Character to print.
  * @param width        Width modifier.
  * @param flags        Flags that change the way the character is printed.
+ * @param ps   Output methods spec for different printf clones.
  * @return     Number of characters printed, negative value on failure.
  */
 static int print_char(char c, int width, uint64_t flags, struct printf_spec *ps)
@@ -166,8 +167,10 @@ static int print_char(char c, int width, uint64_t flags, struct printf_spec *ps)
  * @param width                Width modifier.
  * @param precision    Precision modifier.
  * @param flags                Flags that modify the way the string is printed.
+ * @param ps           Output methods spec for different printf clones.
  * @return             Number of characters printed, negative value on failure.
  */
+/** Structure for specifying output methods for different printf clones. */
 static int print_string(char *s, int width, unsigned int precision,
                        uint64_t flags, struct printf_spec *ps)
 {
@@ -207,10 +210,11 @@ static int print_string(char *s, int width, unsigned int precision,
  * Print significant digits of a number in given base.
  *
  * @param num          Number to print.
- * @param widt         Width modifier.h
+ * @param width                Width modifier.h
  * @param precision    Precision modifier.
  * @param base         Base to print the number in (must be between 2 and 16).
  * @param flags                Flags that modify the way the number is printed.
+ * @param ps           Output methods spec for different printf clones.
  * @return             Number of characters printed.
  */
 static int print_number(uint64_t num, int width, int precision, int base,
@@ -359,7 +363,8 @@ static int print_number(uint64_t num, int width, int precision, int base,
        return counter;
 }
 
-/** Print formatted string.
+/**
+ * Print formatted string.
  *
  * Print string formatted according to the fmt parameter and variadic arguments.
  * Each formatting directive must have the following form: