Changeset 7f0837c in mainline for generic/src/debug/print.c

Timestamp:

2006-04-24T12:59:11Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

fd8af4b

Parents:

24f3874

Message:

Remove the outdated TODO file.
Improve doxygen comments here and there.

File:

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

generic/src/debug/print.c

@@ -81 +81 @@
 }
 
-/** Print one string without appending '\n' to the end
- *
- * Dont use this function directly - printflock is not locked here
+/** Print one string without appending '\n' to the end.
+ *
+ * Do not use this function directly - printflock is not locked here.
  *
  */
@@ -99 +99 @@
 }
 
-/** Print count characters from buffer to output
- *
+/** Print count characters from buffer to output.
+ *
+ * @param buffer Address of the buffer with charaters to be printed.
+ * @param count Number of characters to be printed.
+ *
+ * @return Number of characters printed.
  */
 static int putnchars(const char *buffer, __native count)
@@ -119 +123 @@
 /** Print one formatted character
  *
- * @param c character to print
+ * @param c Character to print.
  * @param width 
  * @param flags
- * @return number of printed characters or EOF
+ * @return Number of printed characters or EOF.
  */
 static int print_char(char c, int width, __u64 flags)
@@ -350 +354 @@
 }
 
-/** General formatted text print
- *
- * Print string formatted according to the fmt parameter
+/** Print formatted string.
+ *
+ * Print string formatted according to the @fmt parameter
  * and variadic arguments. Each formatting directive
  * must have the following form:
@@ -362 +366 @@
  * -    Align to left.
  * +    Print positive sign just as negative.
- *   (space)    If 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 number.
+ *   (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.
  * 
@@ -369 +373 @@
  * 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. 
- * Int parameter expected before parameter for processed conversion specification.
+ * 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.
  *
@@ -391 +395 @@
  * CONVERSIONS:
  * 
- * %    Print percentage character.
+ * %    Print percentage character itself.
  *
  * c    Print single character.
@@ -398 +402 @@
  * 
  * 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.)
@@ -408 +412 @@
  * u    Print unsigned decimal number.
  *
- * 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
+ * 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
  * are printed in verbatim.
  *
  * @param fmt Formatting NULL terminated string.
- * @return count of printed characters or negative value on fail.
+ * @return Number of printed characters or negative value on failure.
  */
 int printf(const char *fmt, ...)