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
This commit is contained in:
Uwe Hermann 2008-08-26 19:37:37 +00:00
parent 1d129fe2db
commit 54ec0afc1c
3 changed files with 13 additions and 6 deletions

View File

@ -35,10 +35,12 @@ extern void i386_do_exec(long addr, int argc, char **argv, int *ret);
#endif #endif
/** /**
* Execute code in memory * Execute code in memory.
* *
* @param ptr The entry point to jump to * @param addr TODO
* @return Return the return value from the entry point * @param argc TODO
* @param argv TODO
* @return Return the return value from the entry point.
*/ */
int exec(long addr, int argc, char **argv) int exec(long addr, int argc, char **argv)
{ {

View File

@ -54,7 +54,7 @@ int dec2bcd(int d)
/** /**
* Return the absolute value of the specified integer. * 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. * @return The absolute value of the specified integer.
*/ */
int abs(int j) int abs(int j)

View File

@ -135,6 +135,7 @@ static int printf_putchar(int c, struct printf_spec *ps)
* @param c Character to print. * @param c Character to print.
* @param width Width modifier. * @param width Width modifier.
* @param flags Flags that change the way the character is printed. * @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. * @return Number of characters printed, negative value on failure.
*/ */
static int print_char(char c, int width, uint64_t flags, struct printf_spec *ps) 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 width Width modifier.
* @param precision Precision modifier. * @param precision Precision modifier.
* @param flags Flags that modify the way the string is printed. * @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. * @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, static int print_string(char *s, int width, unsigned int precision,
uint64_t flags, struct printf_spec *ps) 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. * Print significant digits of a number in given base.
* *
* @param num Number to print. * @param num Number to print.
* @param widt Width modifier.h * @param width Width modifier.h
* @param precision Precision modifier. * @param precision Precision modifier.
* @param base Base to print the number in (must be between 2 and 16). * @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 flags Flags that modify the way the number is printed.
* @param ps Output methods spec for different printf clones.
* @return Number of characters printed. * @return Number of characters printed.
*/ */
static int print_number(uint64_t num, int width, int precision, int base, 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; return counter;
} }
/** Print formatted string. /**
* Print formatted string.
* *
* Print string formatted according to the fmt parameter and variadic arguments. * Print string formatted according to the fmt parameter and variadic arguments.
* Each formatting directive must have the following form: * Each formatting directive must have the following form: