Cleanup: Documentation comments regarding optional parameters.

diff --git a/level_2/fll_error/c/error.h b/level_2/fll_error/c/error.h
index 08c9194..50c0367 100644 (file)
--- a/level_2/fll_error/c/error.h
+++ b/level_2/fll_error/c/error.h
@@ -43,8 +43,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param flag
  *   One of the fll_error_file_flag_*_e flags.
  *   Consider passing fll_error_file_flag_simple_e, on errors like file not find while trying to find file.
@@ -66,8 +67,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param flag
  *   One of the fll_error_file_flag_*_e flags.
  *   Consider passing fll_error_file_flag_simple_e, on errors like file not find while trying to find file.
@@ -95,8 +97,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param flag
  *   One of the fll_error_file_flag_*_e flags.
  *   Consider passing fll_error_file_flag_simple_e, on errors like file not find while trying to find file.

diff --git a/level_2/fll_error/c/private-error.h b/level_2/fll_error/c/private-error.h
index 62bf56d..e8cd396 100644 (file)
--- a/level_2/fll_error/c/private-error.h
+++ b/level_2/fll_error/c/private-error.h
@@ -26,8 +26,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param flag
  *   One of the fll_error_file_flag_*_e flags.
  *   Consider passing fll_error_file_flag_simple_e, on errors like file not find while trying to find file.
@@ -51,8 +52,9 @@ extern "C" {
  * @param print
  *   Designates how printing is to be performed.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  *
  * @return
  *   F_false is returned on successful print of known errors.

diff --git a/level_3/byte_dump/c/main/print/error.h b/level_3/byte_dump/c/main/print/error.h
index 07abea0..ffef64e 100644 (file)
--- a/level_3/byte_dump/c/main/print/error.h
+++ b/level_3/byte_dump/c/main/print/error.h
@@ -46,8 +46,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation

diff --git a/level_3/controller/c/controller/private-controller_print.h b/level_3/controller/c/controller/private-controller_print.h
index 969751b..6e2531d 100644 (file)
--- a/level_3/controller/c/controller/private-controller_print.h
+++ b/level_3/controller/c/controller/private-controller_print.h
@@ -24,8 +24,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param flag
  *   One of the fll_error_file_flag_*_e flags.
  *
@@ -40,6 +41,7 @@ extern "C" {
  *
  * @param thread
  *   (optional) The thread data.
+ *
  *   Set to NULL to disable locking on the thread (this should be done only if the lock is already in place).
  * @param print
  *   Designates how printing is to be performed.
@@ -47,8 +49,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param flag
  *   One of the fll_error_file_flag_*_e flags.
  * @param name

diff --git a/level_3/controller/c/entry/private-entry_print.h b/level_3/controller/c/entry/private-entry_print.h
index 7baddc5..aa9ca72 100644 (file)
--- a/level_3/controller/c/entry/private-entry_print.h
+++ b/level_3/controller/c/entry/private-entry_print.h
@@ -80,8 +80,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param fallback
  *   Set to F_true to print the fallback error message for unknown errors.
  * @param thread
@@ -130,8 +131,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param flag
  *   One of the fll_error_file_flag_*_e flags.
  * @param name

diff --git a/level_3/controller/c/rule/private-rule_print.h b/level_3/controller/c/rule/private-rule_print.h
index 38452e2..aa76385 100644 (file)
--- a/level_3/controller/c/rule/private-rule_print.h
+++ b/level_3/controller/c/rule/private-rule_print.h
@@ -37,8 +37,9 @@ extern "C" {
  *   The status code to process.
  *   Make sure this has F_status_set_fine() called if the status code has any error or warning bits.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param fallback
  *   Set to F_true to print the fallback error message for unknown errors.
  * @param item

diff --git a/level_3/fake/c/main/build.h b/level_3/fake/c/main/build.h
index ea1b40e..fc8d796 100644 (file)
--- a/level_3/fake/c/main/build.h
+++ b/level_3/fake/c/main/build.h
@@ -82,10 +82,11 @@ extern "C" {
  * @param file_stage
  *   The specific stage file path.
  * @param perserve_offset
- *   When a positive number, this represents the amount of characters at the front of each file to ignore.
+ *   (optional) When a positive number, this represents the amount of characters at the front of each file to ignore.
  *   Everything after that is preserved, and the directory is created if necessary.
  *
  *   This is always treated as 0 for any file that is a directory type.
+ *
  *   Set to 0 to disable.
  *
  *   Example: 'sources/c/level_0/fss.h' with a preseve of 10, would result in the path of 'level_0/fss.h' being preserved.

diff --git a/level_3/fake/c/main/print/error.h b/level_3/fake/c/main/print/error.h
index b8ead8c..3b709fc 100644 (file)
--- a/level_3/fake/c/main/print/error.h
+++ b/level_3/fake/c/main/print/error.h
@@ -662,8 +662,9 @@ extern "C" {
  * @param error
  *   Designates how the section error/warning should be printed.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param path
  *   The path to the directory.
  *

diff --git a/level_3/firewall/c/main/print/error.h b/level_3/firewall/c/main/print/error.h
index 0e13b3f..9577266 100644 (file)
--- a/level_3/firewall/c/main/print/error.h
+++ b/level_3/firewall/c/main/print/error.h
@@ -46,8 +46,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation

diff --git a/level_3/fss_identify/c/main/print/error.h b/level_3/fss_identify/c/main/print/error.h
index 3e2a64f..0034cf0 100644 (file)
--- a/level_3/fss_identify/c/main/print/error.h
+++ b/level_3/fss_identify/c/main/print/error.h
@@ -46,8 +46,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation

diff --git a/level_3/fss_read/c/main/print/error.h b/level_3/fss_read/c/main/print/error.h
index 0efb66b..4aad0b0 100644 (file)
--- a/level_3/fss_read/c/main/print/error.h
+++ b/level_3/fss_read/c/main/print/error.h
@@ -48,8 +48,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation

diff --git a/level_3/fss_write/c/main/print/error.h b/level_3/fss_write/c/main/print/error.h
index 9ec1405..6604b3d 100644 (file)
--- a/level_3/fss_write/c/main/print/error.h
+++ b/level_3/fss_write/c/main/print/error.h
@@ -46,8 +46,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation

diff --git a/level_3/iki_read/c/main/print/error.h b/level_3/iki_read/c/main/print/error.h
index 170dba1..9b4fad5 100644 (file)
--- a/level_3/iki_read/c/main/print/error.h
+++ b/level_3/iki_read/c/main/print/error.h
@@ -46,8 +46,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation

diff --git a/level_3/iki_write/c/main/print/error.h b/level_3/iki_write/c/main/print/error.h
index 5febb6c..245f428 100644 (file)
--- a/level_3/iki_write/c/main/print/error.h
+++ b/level_3/iki_write/c/main/print/error.h
@@ -46,8 +46,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation

diff --git a/level_3/utf8/c/main/print/error.h b/level_3/utf8/c/main/print/error.h
index fedc9d6..e01d8de 100644 (file)
--- a/level_3/utf8/c/main/print/error.h
+++ b/level_3/utf8/c/main/print/error.h
@@ -90,8 +90,9 @@ extern "C" {
  *
  *   This does not alter print.custom.setting.state.status.
  * @param function
- *   The name of the function where the error happened.
- *   Set to 0 to disable.
+ *   (optional) The name of the function where the error happened.
+ *
+ *   Set to NULL to disable.
  * @param name
  *   The name of the file or directory.
  * @param operation