From: Kevin Day Date: Mon, 22 Jan 2024 04:50:31 +0000 (-0600) Subject: Cleanup: Fix documentation style regarding optional parameters in the fl_fss and... X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=a9d0b4fbb4a019cde8041e61fc02121b335f4280;p=fll Cleanup: Fix documentation style regarding optional parameters in the fl_fss and the fll_fss projects. 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 b8ebeab..6184acc 100644 --- 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 822ae19..962e577 100644 --- 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 068146a..1873c4c 100644 --- 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 41ff66f..eabb0da 100644 --- 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 d4ec388..035856d 100644 --- 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 2be6056..cc1d8a6 100644 --- 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 e2c6fdb..1f5194f 100644 --- 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 b96a9e9..9c99d56 100644 --- 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 d3bcade..1b7d73f 100644 --- 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 335632a..9d7697c 100644 --- 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 cc8493a..2287f5e 100644 --- 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 c347503..6d2dd37 100644 --- 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 e8c848e..2ba2d64 100644 --- 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