From e86d26370d41819ccdd593432be61fd38b4f3815 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Mon, 22 Aug 2022 18:18:51 -0500 Subject: [PATCH] Cleanup: Fix mistakes in documentation comments. The private function in fll_error should not descrribe itself as an implementation of itself. Remove the pointer from f_string_constant_t in the comments. Fix typo in f_console "strictly". --- level_0/f_console/c/console/common.h | 2 +- level_0/f_string/c/string/common.h | 4 ++-- level_2/fll_error/c/private-error.h | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/level_0/f_console/c/console/common.h b/level_0/f_console/c/console/common.h index c7100d8..daba5bc 100644 --- a/level_0/f_console/c/console/common.h +++ b/level_0/f_console/c/console/common.h @@ -82,7 +82,7 @@ extern "C" { * For example, a "+D +D" means more debug output than simply "+D". * * The verbosity interpretation used as the default for many of the level 3 programs in this process, is to treat verbosity modes as a scale from quiet to debug with quiet as the least verbose and debug as the most verbose. - * This is not stricly a requirement, but expect level 3 projects to work this way. + * This is not strictly a requirement, but expect level 3 projects to work this way. * * The following options are subjective in interpretation of the verbosity but are expected to be follow the general interpretation: * - debug: Enable debugging, which will likely increase output verbosity. diff --git a/level_0/f_string/c/string/common.h b/level_0/f_string/c/string/common.h index 8333260..1004c7b 100644 --- a/level_0/f_string/c/string/common.h +++ b/level_0/f_string/c/string/common.h @@ -78,8 +78,8 @@ extern "C" { * GCC errors such as: "warning: assignment discards ‘const’ qualifier from pointer target type [-Wdiscarded-qualifiers]" can be avoided using this. * * Do not confuse this with "const f_string_static_t". - * When "const f_string_static_t * xxx" is passed to a function, then "xxx" cannot be changed. - * When "f_string_constant_t * xxx" is passed to a function, then "xxx" can be changed. + * When "const f_string_static_t xxx" is passed to a function, then "xxx" cannot be changed. + * When "f_string_constant_t xxx" is passed to a function, then "xxx" can be changed. */ #ifndef _di_f_string_constant_t_ typedef const f_char_t *f_string_constant_t; diff --git a/level_2/fll_error/c/private-error.h b/level_2/fll_error/c/private-error.h index 0599155..4d285ea 100644 --- a/level_2/fll_error/c/private-error.h +++ b/level_2/fll_error/c/private-error.h @@ -16,7 +16,7 @@ extern "C" { #endif /** - * Private implementation of private_fll_error_print(). + * Private implementation of fll_error_print(). * * Intended to be shared to each of the different implementation variations. * -- 1.8.3.1