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 08c91946e84c02916cd28df1318a06277b95d674..50c03674985b4be12dbf5b930e370cf9d341836b 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 62bf56dcb69662488971182d9d7c7e28ae8c30f6..e8cd396b4ac46890b83218d1dbf5867f7477ef7c 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 07abea0f46792bc572aefbf2e4ca63fb59b4b87b..ffef64ec05975f6ebd779c9567ac453ee7d2cb23 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 969751b39bd62821f207683d2a94fcf0419f6457..6e2531dc52ba3bdcf603209e1421a72e4a6fe1d9 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 7baddc54235f510f83d16d3e5b1515897b2c4e96..aa9ca72e11831fc28c66804567398e18b0632fd3 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 38452e26d56cbd7e40d6a675d9baf7853f57ebb3..aa76385b38db47ba41f0b78ddbe8aaf9e55ead7f 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 ea1b40ef8e76a2b880c4d01f5f9712a3a0012fcb..fc8d796c520b95a00e18f9cb521e7c2b775c0eb0 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 b8ead8cff761bc0471d72d148d363ba3e0838310..3b709fc0854b95bdfe7ff45b15bafc4755017d28 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 0e13b3fd0909b1887af9983c1ca53ec859d3b184..957726612789898581cb863ef05597a3f47434d6 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 3e2a64f8dc372fa91bc682856e60ead711daee80..0034cf0ac9ade100641c291033356af6d55642ae 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 0efb66bd9f90c6eac5baeed7e63be8fab2e8a22b..4aad0b07ddc9f29440fdc644b956d16da98107fe 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 9ec140540447c1427b751d25a675e42b562be984..6604b3d7441f71e1d078eaf4bf935d3d37ff7022 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 170dba15410fec977c273642e53e1c04d6c4e597..9b4fad56bf95b58d1c21d094cd511d13dffaea69 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 5febb6c2e8fa8bf92c51d9dfa0713feb344443c3..245f4288a3e80bc928744bb89ca81491455f2a2a 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 fedc9d6245dbdc9e53b884044631f830716abc11..e01d8de8176ac99b5600d7d0446d6cb8825b4036 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