From bdc616938151be67ad286748bd382d068ca80ef2 Mon Sep 17 00:00:00 2001 From: Jon Turney Date: Thu, 12 Nov 2015 13:11:07 +0000 Subject: [PATCH] Simplify the markup for sprintf and swprintf documentation - move the description of the alternative form produced with the # flag from a nested table to an additional table 2015-11-12 Jon Turney * libc/stdio/sprintf.c: Simplify documentation markup. * libc/stdio/swprintf.c: Ditto. Signed-off-by: Jon Turney --- newlib/ChangeLog | 5 +++ newlib/libc/stdio/sprintf.c | 53 +++++++++++++++------------- newlib/libc/stdio/swprintf.c | 68 +++++++++++++++++++----------------- 3 files changed, 69 insertions(+), 57 deletions(-) diff --git a/newlib/ChangeLog b/newlib/ChangeLog index 070622b8f..b56fc0674 100644 --- a/newlib/ChangeLog +++ b/newlib/ChangeLog @@ -1,3 +1,8 @@ +2015-11-12 Jon Turney + + * libc/stdio/sprintf.c: Simplify documentation markup. + * libc/stdio/swprintf.c: Ditto. + 2015-11-12 Jon Turney * libc/stdio/sscanf.c: Improve documentation markup. diff --git a/newlib/libc/stdio/sprintf.c b/newlib/libc/stdio/sprintf.c index c3be9b1d2..d74c6f891 100644 --- a/newlib/libc/stdio/sprintf.c +++ b/newlib/libc/stdio/sprintf.c @@ -199,38 +199,41 @@ DESCRIPTION o # The result is to be converted to an alternative form, according to the <[type]> - character: + character. + o- - o+ - o o - Increases precision to force the first - digit of the result to be a zero. + The alternative form output with the # flag depends on the <[type]> + character: - o x - A non-zero result will have a <<0x>> - prefix. + o+ + o o + Increases precision to force the first + digit of the result to be a zero. - o X - A non-zero result will have a <<0X>> - prefix. + o x + A non-zero result will have a <<0x>> + prefix. - o a, A, e, E, f, or F - The result will always contain a - decimal point even if no digits follow - the point. (Normally, a decimal point - appears only if a digit follows it.) - Trailing zeros are removed. + o X + A non-zero result will have a <<0X>> + prefix. - o g or G - The result will always contain a - decimal point even if no digits follow - the point. Trailing zeros are not - removed. + o a, A, e, E, f, or F + The result will always contain a + decimal point even if no digits follow + the point. (Normally, a decimal point + appears only if a digit follows it.) + Trailing zeros are removed. - o all others - Undefined. + o g or G + The result will always contain a + decimal point even if no digits follow + the point. Trailing zeros are not + removed. + + o all others + Undefined. - o- o- o <[width]> diff --git a/newlib/libc/stdio/swprintf.c b/newlib/libc/stdio/swprintf.c index 60178e52d..2233b3ba7 100644 --- a/newlib/libc/stdio/swprintf.c +++ b/newlib/libc/stdio/swprintf.c @@ -167,40 +167,44 @@ DESCRIPTION o # The result is to be converted to an alternative form, according to the <[type]> - character: - - o+ - o o - Increases precision to force the first - digit of the result to be a zero. - - o x - A non-zero result will have a <<0x>> - prefix. - - o X - A non-zero result will have a <<0X>> - prefix. - - o a, A, e, E, f, or F - The result will always contain a - decimal point even if no digits follow - the point. (Normally, a decimal point - appears only if a digit follows it.) - Trailing zeros are removed. - - o g or G - The result will always contain a - decimal point even if no digits follow - the point. Trailing zeros are not - removed. - - o all others - Undefined. - - o- + character. o- + The alternative form output with the # flag depends on the <[type]> + character: + + o+ + o o + Increases precision to force the first + digit of the result to be a zero. + + o x + A non-zero result will have a <<0x>> + prefix. + + o X + A non-zero result will have a <<0X>> + prefix. + + o a, A, e, E, f, or F + The result will always contain a + decimal point even if no digits follow + the point. (Normally, a decimal point + appears only if a digit follows it.) + Trailing zeros are removed. + + o g or G + The result will always contain a + decimal point even if no digits follow + the point. Trailing zeros are not + removed. + + o all others + Undefined. + + o- + + o <[width]> <[width]> is an optional minimum field width. You can