From: Kevin Day <kevin@kevux.org>
Date: Wed, 31 May 2023 04:29:35 +0000 (-0500)
Subject: Update: Better describe the quote requirements for the documentation comments.
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=ec80434834754418a9e7d2c793e8f695b726b2f8;p=fll

Update: Better describe the quote requirements for the documentation comments.

This is a follow up to the commit e793c5a5b9f3c3c636e55e0b52df1a11590827cb.
---

diff --git a/level_2/fll_fss/c/fss/basic.h b/level_2/fll_fss/c/fss/basic.h
index 49b82fc..efca827 100644
--- a/level_2/fll_fss/c/fss/basic.h
+++ b/level_2/fll_fss/c/fss/basic.h
@@ -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.
diff --git a/level_2/fll_fss/c/fss/extended.h b/level_2/fll_fss/c/fss/extended.h
index b704afb..6df690e 100644
--- a/level_2/fll_fss/c/fss/extended.h
+++ b/level_2/fll_fss/c/fss/extended.h
@@ -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.