]> Kevux Git Server - fll/commitdiff
Update: Better describe the quote requirements for the documentation comments.
authorKevin Day <kevin@kevux.org>
Wed, 31 May 2023 04:29:35 +0000 (23:29 -0500)
committerKevin Day <kevin@kevux.org>
Wed, 31 May 2023 04:29:35 +0000 (23:29 -0500)
This is a follow up to the commit e793c5a5b9f3c3c636e55e0b52df1a11590827cb.

level_2/fll_fss/c/fss/basic.h
level_2/fll_fss/c/fss/extended.h

index 49b82fc0c4cf4eaf689bb7ea88bb2d6520b6d68f..efca82702fbbe71043c776a7fe178d976e0e0419 100644 (file)
@@ -38,7 +38,7 @@ extern "C" {
  * @param contents
  *   This will be populated with all valid contents found.
  * @param objects_quoted
- *   (optional) An array mapped to each object in objects representing the quote discovered, if any.
+ *   (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.
  * @param objects_delimits
  *   An array of delimits for objects detected during processing.
index b704afbcdbb1af0b719503f7b1251b3b3691c3ed..6df690e83da18f19ec7008c73fdd8a69c932b46e 100644 (file)
@@ -38,10 +38,10 @@ extern "C" {
  * @param contents
  *   This will be populated with all valid contents found.
  * @param objects_quoted
- *   (optional) An array mapped to each object in objects representing the quote discovered, if any.
+ *   (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.
  * @param contents_quoted
- *   (optional) An array mapped to each content in contents representing the quote discovered, if any.
+ *   (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.
  * @param objects_delimits
  *   An array of delimits for objects detected during processing.