From aa335d2b7af1ad3e1528b04eee69987bccb55dcf Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sat, 6 Jul 2024 00:30:29 -0500 Subject: [PATCH] Cleanup: Fix incorrect documentation regarding the print functions and the length parameters. --- level_0/f_print/c/print.h | 23 +++++++++-------------- level_0/f_print/c/print/to.h | 15 +++++++-------- 2 files changed, 16 insertions(+), 22 deletions(-) diff --git a/level_0/f_print/c/print.h b/level_0/f_print/c/print.h index 514f030..cee58f7 100644 --- a/level_0/f_print/c/print.h +++ b/level_0/f_print/c/print.h @@ -224,7 +224,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the specified range within the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -334,7 +334,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -371,7 +371,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -406,7 +406,7 @@ extern "C" { * * Will not stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -671,7 +671,7 @@ extern "C" { * Will not stop at NULL. * Will print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -712,7 +712,7 @@ extern "C" { * Will not stop at NULL. * Will print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -751,7 +751,7 @@ extern "C" { * Will not stop at NULL. * Will not print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -910,7 +910,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the specified range within the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1038,7 +1038,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1513,7 +1513,6 @@ extern "C" { * * Will stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -1610,14 +1609,11 @@ extern "C" { * * Will stop at NULL. * Will not print NULL (even as a control character symbol). - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * * @param string * The string to output. - * @param length - * The total number of characters to print. * @param file * The file structure containing a valid stream to output to, including standard streams such as stdout and stderr. * @@ -1644,7 +1640,6 @@ extern "C" { * * Will stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * diff --git a/level_0/f_print/c/print/to.h b/level_0/f_print/c/print/to.h index c9d62a9..f73a53b 100644 --- a/level_0/f_print/c/print/to.h +++ b/level_0/f_print/c/print/to.h @@ -316,7 +316,7 @@ extern "C" { * * Will not stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. + * Will print up to the specified range within the buffer. * * @param buffer * The string to output. @@ -357,7 +357,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -403,7 +403,7 @@ extern "C" { * * Will not stop at NULL. * Will print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -447,7 +447,7 @@ extern "C" { * * Will not stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * @param buffer * The string to output. @@ -819,7 +819,7 @@ extern "C" { * Will not stop at NULL. * Will print NULL. * Will not print any 1-byte character at a location specified in except array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * @@ -1066,7 +1066,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the specified range within the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1225,7 +1225,7 @@ extern "C" { * Will print NULL. * Will not print any 1-byte character at a location specified in except_at array. * Will not print any 1-byte character within the ranges specified in except_in array. - * Will print up to length 1-byte characters. + * Will print up to the length of the buffer. * * All UTF-8 characters, invalid or not, are printed as is. * @@ -1803,7 +1803,6 @@ extern "C" { * * Will stop at NULL. * Will not print NULL. - * Will print up to length 1-byte characters. * * This print function does not use locking, be sure something like flockfile() and funlockfile() are appropriately called. * -- 1.8.3.1