Cleanup: Fix documentation style regarding optional parameters in the fl_fss and...

Change the wording to be consistent with the rest of the project.
There should be "(optional)" in the comments.

diff --git a/level_1/fl_fss/c/fss/basic.h b/level_1/fl_fss/c/fss/basic.h
index b8ebeab4971a89fbe8d447484d7b74811b8feed8..6184acc56cc7b484939db52fa937c5571afcb3f5 100644 (file)
--- a/level_1/fl_fss/c/fss/basic.h
+++ b/level_1/fl_fss/c/fss/basic.h
@@ -155,8 +155,8 @@ extern "C" {
  * @param found
  *   A location where a valid object was found.
  * @param quote
- *   This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
- *   Set pointer address to 0 to not use.
+ *   (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
+ *   Set to NULL to not use.
  * @param delimits
  *   A delimits array representing where delimits exist within the buffer.
  * @param state

diff --git a/level_1/fl_fss/c/fss/basic_list.h b/level_1/fl_fss/c/fss/basic_list.h
index 822ae19b6deac18e46fa7f6b5784e460e3b2b214..962e5772424c5b8978258be726409b762c8da5b1 100644 (file)
--- a/level_1/fl_fss/c/fss/basic_list.h
+++ b/level_1/fl_fss/c/fss/basic_list.h
@@ -111,9 +111,9 @@ extern "C" {
  *   If f_fss_complete_partial_e, this will write any appropriate open and close aspects of this content, except for the final newline.
  *   If f_fss_complete_full_e, this will write any appropriate open and close aspects of this content, including the final newline.
  * @param prepend
- *   A string of whitespace to prepend at the start of each line.
+ *   (optional) A string of whitespace to prepend at the start of each line.
  *   This should only be whitespace, anything else could produce invalid content.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param range
  *   The start/stop location within the content string to write as an content.
  * @param destination

diff --git a/level_1/fl_fss/c/fss/embedded_list.h b/level_1/fl_fss/c/fss/embedded_list.h
index 068146a426cb40e1c6ab74ed7d7de3e143c24171..1873c4c4534ae9fce5631a735644fc29fa0dc375 100644 (file)
--- a/level_1/fl_fss/c/fss/embedded_list.h
+++ b/level_1/fl_fss/c/fss/embedded_list.h
@@ -115,14 +115,14 @@ extern "C" {
  *   If f_fss_complete_partial_e, this will write any appropriate open and close aspects of this content, except for the final newline.
  *   If f_fss_complete_full_e, this will write any appropriate open and close aspects of this content, including the final newline.
  * @param prepend
- *   A string of whitespace to prepend at the start of each line.
+ *   (optional) A string of whitespace to prepend at the start of each line.
  *   This should only be whitespace, anything else could produce invalid content.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param ignore
- *   An optional list of ranges within the string to ignore.
+ *   (optional) A list of ranges within the string to ignore.
  *   These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
  *   Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param range
  *   The start/stop location within the content string to write as an content.
  * @param destination

diff --git a/level_1/fl_fss/c/fss/extended.h b/level_1/fl_fss/c/fss/extended.h
index 41ff66f13087bd8d9f0b3ac06a294ec3ec0d7f19..eabb0da9983187a8555f7a143bf98b436970c3c2 100644 (file)
--- a/level_1/fl_fss/c/fss/extended.h
+++ b/level_1/fl_fss/c/fss/extended.h
@@ -44,8 +44,8 @@ extern "C" {
  * @param found
  *   A set of all locations where a valid content was found.
  * @param quotes
- *   This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
- *   Set pointer address to 0 to not use.
+ *   (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
+ *   Set to NULL to not use.
  * @param delimits
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
@@ -178,8 +178,8 @@ extern "C" {
  * @param found
  *   A location where a valid object was found.
  * @param quote
- *   This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
- *   Set pointer address to 0 to not use.
+ *   (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
+ *   Set to NULL to not use.
  * @param delimits
  *   A delimits array representing where delimits exist within the buffer.
  * @param state

diff --git a/level_1/fl_fss/c/fss/extended_list.h b/level_1/fl_fss/c/fss/extended_list.h
index d4ec3881219a0e5cd89408d08870c662112a8e6d..035856d774b8d0c57de9f0bc7e9223b6193f2aab 100644 (file)
--- a/level_1/fl_fss/c/fss/extended_list.h
+++ b/level_1/fl_fss/c/fss/extended_list.h
@@ -113,14 +113,14 @@ extern "C" {
  *   If f_fss_complete_partial_e, this will write any appropriate open and close aspects of this content, except for the final newline.
  *   If f_fss_complete_full_e, this will write any appropriate open and close aspects of this content, including the final newline.
  * @param prepend
- *   A string of whitespace to prepend at the start of each line.
+ *   (optional) A string of whitespace to prepend at the start of each line.
  *   This should only be whitespace, anything else could produce invalid content.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param ignore
- *   An optional list of ranges within the string to ignore.
+ *   (optional) A list of ranges within the string to ignore.
  *   These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
  *   Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param range
  *   The start/stop location within the content string to write as an content.
  * @param destination

diff --git a/level_1/fl_fss/c/private-fss.h b/level_1/fl_fss/c/private-fss.h
index 2be6056aa22114ed4f7e14ecfe73878d3f4850be..cc1d8a69665632c9a68078c8cbb1a97f3e9a36f3 100644 (file)
--- a/level_1/fl_fss/c/private-fss.h
+++ b/level_1/fl_fss/c/private-fss.h
@@ -103,8 +103,8 @@ extern "C" {
  * @param found
  *   A set of all locations where a valid object was found.
  * @param quote
- *   This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
- *   Set pointer address to 0 to not use.
+ *   (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
+ *   Set to NULL to not use.
  * @param delimits
  *   An array of delimits detected during processing.
  *   The caller is expected to decide if and when to process them.

diff --git a/level_2/fll_fss/c/fss.h b/level_2/fll_fss/c/fss.h
index e2c6fdb10aae74246cd5fff6c5a4a3925b5f844e..1f5194fdfca00f9e86fe862ad981f89ec0425970 100644 (file)
--- a/level_2/fll_fss/c/fss.h
+++ b/level_2/fll_fss/c/fss.h
@@ -100,11 +100,11 @@ extern "C" {
  * @param values
  *   An array of values where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -148,11 +148,11 @@ extern "C" {
  * @param values
  *   An array of values where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -200,11 +200,11 @@ extern "C" {
  * @param values
  *   An array of map arrays where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -252,11 +252,11 @@ extern "C" {
  * @param values
  *   An array of multi map arrays where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -305,11 +305,11 @@ extern "C" {
  * @param values
  *   An array of multi map value arrays where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -356,11 +356,11 @@ extern "C" {
  * @param values
  *   An array of multi map value arrays where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -409,11 +409,11 @@ extern "C" {
  * @param values
  *   An array of map arrays where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -459,11 +459,11 @@ extern "C" {
  * @param values
  *   An array of values where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -507,11 +507,11 @@ extern "C" {
  * @param values
  *   An array of values where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.
@@ -555,11 +555,11 @@ extern "C" {
  * @param values
  *   An array of values where "snatched" content is stored.
  * @param matches
- *   An array representing the if an Object was matched.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the if an Object was matched.
+ *   Set to NULL to not use.
  * @param indexs
- *   An array representing the index within the Objects where the Content match was made.
- *   Set the pointer address to 0 to disable.
+ *   (optional) An array representing the index within the Objects where the Content match was made.
+ *   Set to NULL to not use.
  *
  * @return
  *   F_okay on success.

diff --git a/level_2/fll_fss/c/fss/basic.h b/level_2/fll_fss/c/fss/basic.h
index b96a9e917843dd73a0e6d20e3aac69f981d7ea9e..9c99d567cfbc69850b4460dd570b67daaf3e4685 100644 (file)
--- a/level_2/fll_fss/c/fss/basic.h
+++ b/level_2/fll_fss/c/fss/basic.h
@@ -39,14 +39,14 @@ extern "C" {
  *   This will be populated with all valid contents found.
  * @param objects_quoted
  *   (optional) An array mapped to each object in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param objects_delimits
  *   An array of delimits for objects detected during processing.
  *   The caller is expected to decide if and when to process them.
  * @param contents_delimits
  *   (optional) An array of delimits for contents detected during processing.
  *   The caller is expected to decide if and when to process them.
- *   Set pointer address to 0 and all delimits will instead utilize objects_delimits.
+ *   Set to NULL and all delimits will instead utilize objects_delimits.
  * @param state
  A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().

diff --git a/level_2/fll_fss/c/fss/basic_list.h b/level_2/fll_fss/c/fss/basic_list.h
index d3bcadee3eee9fcc2551ab530dcf7c7e9a3f6884..1b7d73fdd4a4b6729884def6e7a2d21f6d548866 100644 (file)
--- a/level_2/fll_fss/c/fss/basic_list.h
+++ b/level_2/fll_fss/c/fss/basic_list.h
@@ -43,7 +43,7 @@ extern "C" {
  * @param contents_delimits
  *   (optional) An array of delimits for contents detected during processing.
  *   The caller is expected to decide if and when to process them.
- *   Set pointer address to 0 and all delimits will instead utilize objects_delimits.
+ *   Set to NULL and all delimits will instead utilize objects_delimits.
  * @param comments
  *   An array of ranges representing where comments are found within any valid content.
  *   This only stores comments found within valid content only.
@@ -88,8 +88,8 @@ extern "C" {
  * @param content
  *   A string representing the content.
  * @param content_prepend
- *   A string to prepend at the start of each line in content, such as spaces.
- *   Set the pointer address to 0 to disable.
+ *   (optional) A string to prepend at the start of each line in content, such as spaces.
+ *   Set to NULL to not use.
  * @param destination
  *   The buffer to write to.
  * @param state

diff --git a/level_2/fll_fss/c/fss/embedded_list.h b/level_2/fll_fss/c/fss/embedded_list.h
index 335632adfc7659f94843dda11c7878943651a4d4..9d7697cf22b00ecacab89695d6f5b9a7e00b94e9 100644 (file)
--- a/level_2/fll_fss/c/fss/embedded_list.h
+++ b/level_2/fll_fss/c/fss/embedded_list.h
@@ -41,7 +41,7 @@ extern "C" {
  * @param contents_delimits
  *   (optional) An array of delimits for contents detected during processing.
  *   The caller is expected to decide if and when to process them.
- *   Set pointer address to 0 and all delimits will instead utilize objects_delimits.
+ *   Set to NULL and all delimits will instead utilize objects_delimits.
  * @param comments
  *   An array of ranges representing where comments are found within any valid content.
  *   This only stores comments found within valid content only.
@@ -88,13 +88,13 @@ extern "C" {
  * @param content
  *   A string representing the content.
  * @param content_prepend
- *   A string to prepend at the start of each line in content, such as spaces.
- *   Set the pointer address to 0 to disable.
+ *   (optional) A string to prepend at the start of each line in content, such as spaces.
+ *   Set to NULL to not use.
  * @param ignore
- *   An optional list of ranges within the string to ignore.
+ *   (optional) A list of ranges within the string to ignore.
  *   These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
  *   Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param destination
  *   The buffer where the content is written to.
  * @param state

diff --git a/level_2/fll_fss/c/fss/extended.h b/level_2/fll_fss/c/fss/extended.h
index cc8493aa119790e2636e419efb9e3a4989639c58..2287f5ed165ca06f46a3c3f9ad4b0b58a140c0c9 100644 (file)
--- a/level_2/fll_fss/c/fss/extended.h
+++ b/level_2/fll_fss/c/fss/extended.h
@@ -39,17 +39,17 @@ extern "C" {
  *   This will be populated with all valid contents found.
  * @param objects_quoted
  *   (optional) An array mapped to each object in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param contents_quoted
  *   (optional) An array mapped to each content in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param objects_delimits
  *   An array of delimits for objects detected during processing.
  *   The caller is expected to decide if and when to process them.
  * @param contents_delimits
  *   (optional) An array of delimits for contents detected during processing.
  *   The caller is expected to decide if and when to process them.
- *   Set pointer address to 0 and all delimits will instead utilize objects_delimits.
+ *   Set to NULL and all delimits will instead utilize objects_delimits.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().

diff --git a/level_2/fll_fss/c/fss/extended_list.h b/level_2/fll_fss/c/fss/extended_list.h
index c3475039fc300a3017d22f73a77313f28d3c0d56..6d2dd3777c897c0782064075bf48ae033b572033 100644 (file)
--- a/level_2/fll_fss/c/fss/extended_list.h
+++ b/level_2/fll_fss/c/fss/extended_list.h
@@ -45,7 +45,7 @@ extern "C" {
  * @param contents_delimits
  *   (optional) An array of delimits for contents detected during processing.
  *   The caller is expected to decide if and when to process them.
- *   Set pointer address to 0 and all delimits will instead utilize objects_delimits.
+ *   Set to NULL 0 and all delimits will instead utilize objects_delimits.
  * @param comments
  *   An array of ranges representing where comments are found within any valid content.
  *   This only stores comments found within valid content only.
@@ -92,13 +92,13 @@ extern "C" {
  * @param content
  *   A string representing the content.
  * @param content_prepend
- *   A string to prepend at the start of each line in content, such as spaces.
- *   Set the pointer address to 0 to disable.
+ *   (optional) A string to prepend at the start of each line in content, such as spaces.
+ *   Set to NULL to not use.
  * @param ignore
- *   An optional list of ranges within the string to ignore.
+ *   (optional) A list of ranges within the string to ignore.
  *   These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
  *   Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param destination
  *   The buffer where the content is written to.
  * @param state

diff --git a/level_2/fll_fss/c/fss/payload.h b/level_2/fll_fss/c/fss/payload.h
index e8c848eb3718ef4908a3c3ec49a9b27a2d80d35f..2ba2d64949098fb4d03a4c3bc6803d7ad515481f 100644 (file)
--- a/level_2/fll_fss/c/fss/payload.h
+++ b/level_2/fll_fss/c/fss/payload.h
@@ -49,7 +49,7 @@ extern "C" {
  * @param contents_delimits
  *   (optional) An array of delimits for contents detected during processing.
  *   The caller is expected to decide if and when to process them.
- *   Set pointer address to 0 and all delimits will instead utilize objects_delimits.
+ *   Set to NULL and all delimits will instead utilize objects_delimits.
  * @param comments
  *   An array of ranges representing where comments are found within any valid content.
  *   This only stores comments found within valid content only.
@@ -114,9 +114,9 @@ extern "C" {
  *   If FALSE, the Object is passed f_fss_complete_full_e.
  *   The Content is always passed f_fss_complete_full_e.
  * @param content_prepend
- *   A string to prepend at the start of each line in content, such as spaces.
+ *   (optional) A string to prepend at the start of each line in content, such as spaces.
  *   This will not be prepended for the Object "payload".
- *   Set the pointer address to 0 to disable.
+ *   Set to NULL to not use.
  * @param destination
  *   The buffer to append to.
  * @param state