From: Kevin Day <Kevin@kevux.org>
Date: Sun, 19 Jan 2025 23:03:36 +0000 (-0600)
Subject: Update: Add missing constant qualifiers and update function comments.
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=1809ab51013bf02ab591729ad684a9cf0362b8d8;p=fll

Update: Add missing constant qualifiers and update function comments.

Some functions are missing the standard constant qualifier on the pointer parameters.

Improve grammar in some of the documentation comments.
---

diff --git a/level_0/f_string/c/string.c b/level_0/f_string/c/string.c
index 8c17e6e..5b26bc2 100644
--- a/level_0/f_string/c/string.c
+++ b/level_0/f_string/c/string.c
@@ -274,7 +274,7 @@ extern "C" {
 #endif // _di_f_string_prepend_nulless_
 
 #ifndef _di_f_string_seek_line_
-  f_status_t f_string_seek_line(const f_string_t string, f_range_t *range) {
+  f_status_t f_string_seek_line(const f_string_t string, f_range_t * const range) {
     #ifndef _di_level_0_parameter_checking_
       if (!range) return F_status_set_error(F_parameter);
     #endif // _di_level_0_parameter_checking_
diff --git a/level_0/f_string/c/string.h b/level_0/f_string/c/string.h
index 656f25d..a869348 100644
--- a/level_0/f_string/c/string.h
+++ b/level_0/f_string/c/string.h
@@ -401,7 +401,7 @@ extern "C" {
  *   The string to traverse.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -427,7 +427,7 @@ extern "C" {
  *   A single-width character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -450,7 +450,7 @@ extern "C" {
  *   A single-width character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
diff --git a/level_0/f_string/c/string/dynamic.h b/level_0/f_string/c/string/dynamic.h
index d097ab8..d18299c 100644
--- a/level_0/f_string/c/string/dynamic.h
+++ b/level_0/f_string/c/string/dynamic.h
@@ -672,7 +672,7 @@ extern "C" {
  *   The buffer to traverse.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -698,7 +698,7 @@ extern "C" {
  *   A single-width character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -724,7 +724,7 @@ extern "C" {
  *   A single-width character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
diff --git a/level_0/f_utf/c/utf.c b/level_0/f_utf/c/utf.c
index 2ebeacd..5c04b1b 100644
--- a/level_0/f_utf/c/utf.c
+++ b/level_0/f_utf/c/utf.c
@@ -7,7 +7,7 @@ extern "C" {
 #endif
 
 #ifndef _di_f_utf_buffer_decrement_
-  f_status_t f_utf_buffer_decrement(const f_string_static_t buffer, f_range_t *range, const f_number_unsigned_t step) {
+  f_status_t f_utf_buffer_decrement(const f_string_static_t buffer, f_range_t * const range, const f_number_unsigned_t step) {
     #ifndef _di_level_0_parameter_checking_
       if (!range) return F_status_set_error(F_parameter);
       if (step < 1) return F_status_set_error(F_parameter);
@@ -41,7 +41,7 @@ extern "C" {
 #endif // _di_f_utf_buffer_decrement_
 
 #ifndef _di_f_utf_buffer_increment_
-  f_status_t f_utf_buffer_increment(const f_string_static_t buffer, f_range_t *range, const f_number_unsigned_t step) {
+  f_status_t f_utf_buffer_increment(const f_string_static_t buffer, f_range_t * const range, const f_number_unsigned_t step) {
     #ifndef _di_level_0_parameter_checking_
       if (!range) return F_status_set_error(F_parameter);
       if (step < 1) return F_status_set_error(F_parameter);
diff --git a/level_0/f_utf/c/utf.h b/level_0/f_utf/c/utf.h
index a0d1338..098195e 100644
--- a/level_0/f_utf/c/utf.h
+++ b/level_0/f_utf/c/utf.h
@@ -100,7 +100,7 @@ extern "C" {
  *   F_parameter (with error bit) if a parameter is invalid.
  */
 #ifndef _di_f_utf_buffer_decrement_
-  extern f_status_t f_utf_buffer_decrement(const f_string_static_t buffer, f_range_t *range, const f_number_unsigned_t step);
+  extern f_status_t f_utf_buffer_decrement(const f_string_static_t buffer, f_range_t * const range, const f_number_unsigned_t step);
 #endif // _di_f_utf_buffer_decrement_
 
 /**
@@ -133,7 +133,7 @@ extern "C" {
  *   F_parameter (with error bit) if a parameter is invalid.
  */
 #ifndef _di_f_utf_buffer_increment_
-  extern f_status_t f_utf_buffer_increment(const f_string_static_t buffer, f_range_t *range, const f_number_unsigned_t step);
+  extern f_status_t f_utf_buffer_increment(const f_string_static_t buffer, f_range_t * const range, const f_number_unsigned_t step);
 #endif // _di_f_utf_buffer_increment_
 
 #ifdef __cplusplus
diff --git a/level_0/f_utf/c/utf/dynamic.h b/level_0/f_utf/c/utf/dynamic.h
index 7056504..f546614 100644
--- a/level_0/f_utf/c/utf/dynamic.h
+++ b/level_0/f_utf/c/utf/dynamic.h
@@ -670,7 +670,7 @@ extern "C" {
  *   The buffer to traverse.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -697,7 +697,7 @@ extern "C" {
  *   A single-width character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -724,7 +724,7 @@ extern "C" {
  *   A single-width character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
diff --git a/level_0/f_utf/c/utf/string.c b/level_0/f_utf/c/utf/string.c
index b0e22ed..25dd41a 100644
--- a/level_0/f_utf/c/utf/string.c
+++ b/level_0/f_utf/c/utf/string.c
@@ -294,7 +294,7 @@ extern "C" {
 #endif // _di_f_utf_string_prepend_nulless_
 
 #ifndef _di_f_utf_string_seek_line_
-  f_status_t f_utf_string_seek_line(const f_utf_string_t string, f_range_t *range) {
+  f_status_t f_utf_string_seek_line(const f_utf_string_t string, f_range_t * const range) {
     #ifndef _di_level_0_parameter_checking_
       if (!range) return F_status_set_error(F_parameter);
     #endif // _di_level_0_parameter_checking_
diff --git a/level_0/f_utf/c/utf/string.h b/level_0/f_utf/c/utf/string.h
index 41fe881..c419b78 100644
--- a/level_0/f_utf/c/utf/string.h
+++ b/level_0/f_utf/c/utf/string.h
@@ -354,7 +354,7 @@ extern "C" {
  *   The string to traverse.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -380,7 +380,7 @@ extern "C" {
  *   A character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -403,7 +403,7 @@ extern "C" {
  *   A character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
diff --git a/level_0/f_utf/c/utf/strings.c b/level_0/f_utf/c/utf/strings.c
index 9ec3a9a..7639bc7 100644
--- a/level_0/f_utf/c/utf/strings.c
+++ b/level_0/f_utf/c/utf/strings.c
@@ -282,7 +282,7 @@ extern "C" {
 #endif // _di_f_utf_string_prepend_nulless_
 
 #ifndef _di_f_utf_string_seek_line_
-  f_status_t f_utf_string_seek_line(const f_utf_string_t string, f_range_t *range) {
+  f_status_t f_utf_string_seek_line(const f_utf_string_t string, f_range_t * const range) {
     #ifndef _di_level_0_parameter_checking_
       if (!range) return F_status_set_error(F_parameter);
     #endif // _di_level_0_parameter_checking_
diff --git a/level_0/f_utf/c/utf/strings.h b/level_0/f_utf/c/utf/strings.h
index 41fe881..c419b78 100644
--- a/level_0/f_utf/c/utf/strings.h
+++ b/level_0/f_utf/c/utf/strings.h
@@ -354,7 +354,7 @@ extern "C" {
  *   The string to traverse.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -380,7 +380,7 @@ extern "C" {
  *   A character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -403,7 +403,7 @@ extern "C" {
  *   A character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
diff --git a/level_0/f_utf/c/utf/stringss.c b/level_0/f_utf/c/utf/stringss.c
index 9ce8e1c..5d5386c 100644
--- a/level_0/f_utf/c/utf/stringss.c
+++ b/level_0/f_utf/c/utf/stringss.c
@@ -282,7 +282,7 @@ extern "C" {
 #endif // _di_f_utf_string_prepend_nulless_
 
 #ifndef _di_f_utf_string_seek_line_
-  f_status_t f_utf_string_seek_line(const f_utf_string_t string, f_range_t *range) {
+  f_status_t f_utf_string_seek_line(const f_utf_string_t string, f_range_t * const range) {
     #ifndef _di_level_0_parameter_checking_
       if (!range) return F_status_set_error(F_parameter);
     #endif // _di_level_0_parameter_checking_
diff --git a/level_0/f_utf/c/utf/stringss.h b/level_0/f_utf/c/utf/stringss.h
index 41fe881..c419b78 100644
--- a/level_0/f_utf/c/utf/stringss.h
+++ b/level_0/f_utf/c/utf/stringss.h
@@ -354,7 +354,7 @@ extern "C" {
  *   The string to traverse.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -380,7 +380,7 @@ extern "C" {
  *   A character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
@@ -403,7 +403,7 @@ extern "C" {
  *   A character representing a character to seek to.
  * @param range
  *   A range within the buffer representing the start and stop locations.
- *   The start location will be incremented by seek.
+ *   The start location will be incremented by the seek.
  *
  * @return
  *   F_okay on success.
diff --git a/level_1/fl_fss/c/fss/basic_list.c b/level_1/fl_fss/c/fss/basic_list.c
index e7a081c..a04b3a9 100644
--- a/level_1/fl_fss/c/fss/basic_list.c
+++ b/level_1/fl_fss/c/fss/basic_list.c
@@ -292,7 +292,7 @@ extern "C" {
 #endif // _di_fl_fss_basic_list_content_read_
 
 #ifndef _di_fl_fss_basic_list_content_write_
-  void fl_fss_basic_list_content_write(const f_string_static_t content, const uint8_t complete, const f_string_static_t * const prepend, f_range_t *range, f_string_dynamic_t *destination, f_state_t * const state) {
+  void fl_fss_basic_list_content_write(const f_string_static_t content, const uint8_t complete, const f_string_static_t * const prepend, f_range_t * const range, f_string_dynamic_t * const destination, f_state_t * const state) {
     #ifndef _di_level_1_parameter_checking_
       if (!state) return;