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 8c17e6eb3429a5f6b1b05b4bc0db21861f417cd1..5b26bc2cac6a7cad79a195e36a6a6030e51db646 100644 (file)
--- 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 656f25dd7e7087ee4ac3934353d59be7b443f0df..a869348b173cae41be4af6f30d699f4f978919f9 100644 (file)
--- 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 d097ab85ae0c43b5bf4d7f42ece9942a65fe123a..d18299cd651a743dadfdbc5bd16fd9fcf276950c 100644 (file)
--- 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 2ebeacda834c9a48fae848776da64d0e2e3cc9c9..5c04b1b8bb560b66669512e01d538cb55aa77a99 100644 (file)
--- 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 a0d133800d721f49dec3d0e306ec9846dacc50e6..098195e924a0a2ea2320c58ec8c49496865ef091 100644 (file)
--- 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 7056504cd53ac706afc0d81fb41d62ff73f89c40..f546614d82edef07f337c9b8384419466057cde4 100644 (file)
--- 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 b0e22ed61f855a92df1ab54d89fa1061fb6cd4c6..25dd41a1987c4cd58d32c8b7abca9fca0b0145a6 100644 (file)
--- 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 41fe881d0efba98bebf82d80de2d400cf5b01d7b..c419b78c04ef2e6f6f973b02a4f14217d404d43f 100644 (file)
--- 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 9ec3a9a1585a3ccdedc7ecffef659e9944382d2c..7639bc7e082057d5e0c8c286cf2ccc225b9abd2b 100644 (file)
--- 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 41fe881d0efba98bebf82d80de2d400cf5b01d7b..c419b78c04ef2e6f6f973b02a4f14217d404d43f 100644 (file)
--- 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 9ce8e1c852ee7a769e0a6d48ec05e3e56408371f..5d5386c13da623da053abb859f78b3a5f59985d0 100644 (file)
--- 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 41fe881d0efba98bebf82d80de2d400cf5b01d7b..c419b78c04ef2e6f6f973b02a4f14217d404d43f 100644 (file)
--- 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 e7a081ca8713ba7c633b655c0281967fe847c1e7..a04b3a942c19fe5f14f8956cce1d8a237a53003d 100644 (file)
--- 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;