From: Kevin Day <kevin@kevux.org>
Date: Sun, 28 Jan 2024 06:45:54 +0000 (-0600)
Subject: Cleanup: Bad documentation comment syntax in fll_fss functions.
X-Git-Tag: 0.6.9~36
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=26cfe577e6de29af4a271ab0c5f0a5f9ae2cfaa1;p=fll

Cleanup: Bad documentation comment syntax in fll_fss functions.
---

diff --git a/level_2/fll_fss/c/fss/basic.h b/level_2/fll_fss/c/fss/basic.h
index 7cd7bc9..4418f0b 100644
--- a/level_2/fll_fss/c/fss/basic.h
+++ b/level_2/fll_fss/c/fss/basic.h
@@ -33,7 +33,7 @@ extern "C" {
  * @param buffer
  *   The buffer to read from.
  * @param state
- A state for providing flags and handling interrupts during long running operations.
+ *   A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().
  *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
diff --git a/level_2/fll_fss/c/fss/basic_list.h b/level_2/fll_fss/c/fss/basic_list.h
index e7617ef..604605f 100644
--- a/level_2/fll_fss/c/fss/basic_list.h
+++ b/level_2/fll_fss/c/fss/basic_list.h
@@ -33,7 +33,7 @@ extern "C" {
  * @param buffer
  *   The buffer to read from.
  * @param state
- A state for providing flags and handling interrupts during long running operations.
+ *   A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().
  *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
diff --git a/level_2/fll_fss/c/fss/embedded_list.h b/level_2/fll_fss/c/fss/embedded_list.h
index f45ecdc..9c7e423 100644
--- a/level_2/fll_fss/c/fss/embedded_list.h
+++ b/level_2/fll_fss/c/fss/embedded_list.h
@@ -32,7 +32,7 @@ extern "C" {
  * @param buffer
  *   The buffer to read from.
  * @param state
- A state for providing flags and handling interrupts during long running operations.
+ *   A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().
  *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
diff --git a/level_2/fll_fss/c/fss/extended.h b/level_2/fll_fss/c/fss/extended.h
index 33ca876..3ba8b34 100644
--- a/level_2/fll_fss/c/fss/extended.h
+++ b/level_2/fll_fss/c/fss/extended.h
@@ -32,7 +32,7 @@ extern "C" {
  * @param buffer
  *   The buffer to read from.
  * @param state
- A state for providing flags and handling interrupts during long running operations.
+ *   A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().
  *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
diff --git a/level_2/fll_fss/c/fss/extended_list.h b/level_2/fll_fss/c/fss/extended_list.h
index 3b250a0..fd7b1b4 100644
--- a/level_2/fll_fss/c/fss/extended_list.h
+++ b/level_2/fll_fss/c/fss/extended_list.h
@@ -34,7 +34,7 @@ extern "C" {
  * @param buffer
  *   The buffer to read from.
  * @param state
- A state for providing flags and handling interrupts during long running operations.
+ *   A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().
  *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
diff --git a/level_2/fll_fss/c/fss/payload.h b/level_2/fll_fss/c/fss/payload.h
index cebb19c..bd638bb 100644
--- a/level_2/fll_fss/c/fss/payload.h
+++ b/level_2/fll_fss/c/fss/payload.h
@@ -33,12 +33,12 @@ extern "C" {
  * This processes only the outermost part and specially handles the payload.
  * The inner data, such as the fss-0001 inside of the "header", should be directly processed via the appropriate function.
  *
- * The "payload" Object is required and if it is not file, this function returns with the error flag set.
+ * The "payload" Object is required and if it is not found, this function returns with the error flag set.
  *
  * @param buffer
  *   The buffer to read from.
  * @param state
- A state for providing flags and handling interrupts during long running operations.
+ *   A state for providing flags and handling interrupts during long running operations.
  *   There is no state.handle().
  *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.