Changeset 040e4e9 in mainline

Timestamp:

2006-04-27T18:27:01Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

11928d5

Parents:

9179d0a

Message:

Improve doxygen comments for printf().

File:

• generic/src/debug/print.c (modified) (4 diffs)

generic/src/debug/print.c

@@ -81 +81 @@
 }
 
-/** Print one string without appending '\n' to the end.
+/** Print one string without appending newline to the end.
  *
  * Do not use this function directly - printflock is not locked here.
@@ -356 +356 @@
 /** Print formatted string.
  *
- * Print string formatted according to the @fmt parameter
+ * Print string formatted according to the fmt parameter
  * and variadic arguments. Each formatting directive
  * must have the following form:
- * % [ flags ] [ width ] [ .precision ] [ type ] conversion
- *
- * FLAGS:
- * #    Force to print prefix.
- *      For conversion %o the prefix is 0, for %x and %X prefixes are 0x and 0X and for conversion %b the prefix is 0b.
- * -    Align to left.
- * +    Print positive sign just as negative.
- *   (space)    If the printed number is positive and '+' flag is not set, print space in place of sign.
- * 0    Print 0 as padding instead of spaces. Zeroes are placed between sign and the rest of the number.
- *      This flag is ignored if '-' flag is specified.
- * 
- * WIDTH:
+ * 
+ *      \% [ FLAGS ] [ WIDTH ] [ .PRECISION ] [ TYPE ] CONVERSION
+ *
+ * FLAGS:@n
+ * "#"  Force to print prefix.
+ *      For conversion \%o the prefix is 0, for %x and \%X prefixes are 0x and 0X
+ *      and for conversion \%b the prefix is 0b.
+ *
+ * "-"  Align to left.
+ *
+ * "+"  Print positive sign just as negative.
+ *
+ * " "  If the printed number is positive and "+" flag is not set, print space in
+ *      place of sign.
+ *
+ * "0"  Print 0 as padding instead of spaces. Zeroes are placed between sign and the
+ *      rest of the number. This flag is ignored if "-" flag is specified.
+ * 
+ * WIDTH:@n
  * Specify minimal width of printed argument. If it is bigger, width is ignored.
- * If width is specified with a '*' character instead of number, width is taken from parameter list. 
- * And integer parameter is expected before parameter for processed conversion specification.
- * If this value is negative its absolute value is taken and the '-' flag is set.
- *
- * PRECISION:
+ * If width is specified with a "*" character instead of number, width is taken from
+ * parameter list. And integer parameter is expected before parameter for processed
+ * conversion specification. If this value is negative its absolute value is taken
+ * and the "-" flag is set.
+ *
+ * PRECISION:@n
  * Value precision. For numbers it specifies minimum valid numbers.
  * Smaller numbers are printed with leading zeroes. Bigger numbers are not affected.
  * Strings with more than precision characters are cut off.
- * Just as with width, an '*' can be used used instead of a number.
- * An integer value is then expected in parameters. When both width and precision are specified using '*',
- * first parameter is used for width and second one for precision.
- * 
- * TYPE:
- * hh   signed or unsigned char
- * h    signed or usigned short
- *      signed or usigned int (default value)
- * l    signed or usigned long int
- * ll   signed or usigned long long int
- * z    __native (non-standard extension)
- * 
- * 
- * CONVERSIONS:
- * 
- * %    Print percentage character itself.
+ * Just as with width, an "*" can be used used instead of a number.
+ * An integer value is then expected in parameters. When both width and precision
+ * are specified using "*", the first parameter is used for width and the second one
+ * for precision.
+ * 
+ * TYPE:@n
+ * "hh" Signed or unsigned char.@n
+ * "h"  Signed or usigned short.@n
+ * ""   Signed or usigned int (default value).@n
+ * "l"  Signed or usigned long int.@n
+ * "ll" Signed or usigned long long int.@n
+ * "z"  __native (non-standard extension).@n
+ * 
+ * 
+ * CONVERSION:@n
+ * %    Print percentile character itself.
  *
  * c    Print single character.
@@ -402 +410 @@
  * 
  * P, p Print value of a pointer. Void * value is expected and it is printed in hexadecimal notation with prefix
- * (as with %#X or %#x for 32bit or %#X / %#x for 64bit long pointers).
+ *      (as with \%#X or \%#x for 32bit or \%#X / \%#x for 64bit long pointers).
  *
  * b    Print value as unsigned binary number. Prefix is not printed by default. (Nonstandard extension.)
@@ -414 +422 @@
  * X, x Print hexadecimal number with upper- or lower-case. Prefix is not printed by default.
  * 
- * All other characters from @fmt except the formatting directives
+ * All other characters from fmt except the formatting directives
  * are printed in verbatim.
  *