From 4fe8cc35260bce475bb240a24cda14a072e0034d Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 10 Jul 2022 17:04:57 -0500 Subject: [PATCH] Cleanup: Fix documentation comments. --- level_0/f_file/c/file.h | 2 +- level_0/f_utf/c/utf/convert.h | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/level_0/f_file/c/file.h b/level_0/f_file/c/file.h index 5c367a8..0ae9c1f 100644 --- a/level_0/f_file/c/file.h +++ b/level_0/f_file/c/file.h @@ -2098,7 +2098,7 @@ extern "C" { * @param mode * The file modes do use when opening, as an fopen() file mode string. * Set mode.used to 0 to determine mode from file.flags (falling back to read only as a failsafe). - * If neither truncate nor append are not specified in write only mode, then the failsafe is to append. + * If neither truncate nor append are specified in write only mode, then the failsafe is to append. * * File Modes (fopen() file modes vs open file modes): * - "r": O_RDONLY. diff --git a/level_0/f_utf/c/utf/convert.h b/level_0/f_utf/c/utf/convert.h index 4e2b7c3..db92062 100644 --- a/level_0/f_utf/c/utf/convert.h +++ b/level_0/f_utf/c/utf/convert.h @@ -154,8 +154,9 @@ extern "C" { * There must be enough space in the character buffer to handle the Unicode width. * It is recommended to always have 4 characters (4 uint8_t) of space available in character. * @param character - * The (UTF-8) character. - * The f_utf_char_t is a 32-bit integer containing UTF-8 sequences. + * The (UTF-8) character as a sequence of bytes. + * This must have a length equal to the width (up to 4 characters) to be safely used. + * The caller is expected to ensure this. * * @return * F_none on success. -- 1.8.3.1