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 7cd7bc9b42b848e3c7b2ac5c6e876affdab38ba8..4418f0b281675bfa5ee464628e3f75d2f9015fbd 100644 (file)
--- 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 e7617efcc35f8f05162a1cde5b4fa1dd7cbad217..604605ffc82e33eea12197b1bc957ba6e32bcb24 100644 (file)
--- 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 f45ecdcec292212a9de5a9c303dd01a3ea3a0043..9c7e42361fd7a2ada726e3ccc62ad7962196f94a 100644 (file)
--- 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 33ca87654fcdba6912c4e7bae9b8d7c6dac115e8..3ba8b34c7a073a147f00379e5d0b1b75dcb0e2e2 100644 (file)
--- 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 3b250a0b41f14b74fa84c37018f16a2dfb0e6f0e..fd7b1b4ef92fbe4e7db78e30534e75c1272457e1 100644 (file)
--- 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 cebb19cca97371c0f5394d08de3c290111fabbfe..bd638bb270294f044e463b49aa22289fb70cb928 100644 (file)
--- 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.