]> Kevux Git Server - fll/commitdiff
Cleanup: Documentation comments in regards to f_state_t.
authorKevin Day <kevin@kevux.org>
Tue, 7 Mar 2023 01:45:12 +0000 (19:45 -0600)
committerKevin Day <kevin@kevux.org>
Tue, 7 Mar 2023 01:46:10 +0000 (19:46 -0600)
Several of the documentation comments regarding f_state_t are now no longer out of date.

13 files changed:
level_0/f_iki/c/iki.h
level_1/fl_fss/c/fss/basic.h
level_1/fl_fss/c/fss/basic_list.h
level_1/fl_fss/c/fss/embedded_list.h
level_1/fl_fss/c/fss/extended.h
level_1/fl_fss/c/fss/extended_list.h
level_1/fl_fss/c/private-fss.h
level_2/fll_fss/c/fss/basic.h
level_2/fll_fss/c/fss/basic_list.h
level_2/fll_fss/c/fss/embedded_list.h
level_2/fll_fss/c/fss/extended.h
level_2/fll_fss/c/fss/extended_list.h
level_2/fll_fss/c/fss/payload.h

index f34e0bd..ae7b9f3 100644 (file)
@@ -145,12 +145,12 @@ extern "C" {
  *   The IKI variable data.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *   This must not be NULL.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 5993898..9bdbb62 100644 (file)
@@ -47,11 +47,11 @@ extern "C" {
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -104,11 +104,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *
  * @return
@@ -155,11 +155,11 @@ extern "C" {
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -227,11 +227,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 0b62d4d..c396bb7 100644 (file)
@@ -52,11 +52,11 @@ extern "C" {
  *   The comment range will include the trailing newline.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -119,11 +119,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -176,11 +176,11 @@ extern "C" {
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -242,11 +242,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index d717c95..0b6a5c6 100644 (file)
@@ -56,11 +56,11 @@ extern "C" {
  *   The comment range will include the trailing newline.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -130,11 +130,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -186,11 +186,11 @@ extern "C" {
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -252,11 +252,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index bca23bc..b70667f 100644 (file)
@@ -50,11 +50,11 @@ extern "C" {
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -121,11 +121,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -182,11 +182,11 @@ extern "C" {
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -257,11 +257,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index aa3f1ee..914da76 100644 (file)
@@ -54,11 +54,11 @@ extern "C" {
  *   The comment range will include the trailing newline.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -126,11 +126,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -182,11 +182,11 @@ extern "C" {
  *   A delimits array representing where delimits exist within the buffer.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -248,11 +248,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 3991e28..8b7a679 100644 (file)
@@ -26,11 +26,11 @@ extern "C" {
  *   The buffer where the bytes are written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -59,11 +59,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -110,11 +110,11 @@ extern "C" {
  *   The caller is expected to decide if and when to process them.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -182,11 +182,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -234,11 +234,11 @@ extern "C" {
  *   The buffer where the object is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 0c0ec24..488c26a 100644 (file)
@@ -50,11 +50,11 @@ extern "C" {
  *   Set pointer address to 0 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 print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -99,11 +99,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 7bb2f0c..5b2370d 100644 (file)
@@ -50,11 +50,11 @@ extern "C" {
  *   This only stores comments found within valid content only.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -98,11 +98,11 @@ extern "C" {
  *   The buffer to write to.
  * @param state
  A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 2c67423..41aa3df 100644 (file)
@@ -47,11 +47,11 @@ extern "C" {
  *   This only stores comments found within valid content only.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -102,11 +102,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 9dbb5d9..b64095f 100644 (file)
@@ -52,11 +52,11 @@ extern "C" {
  *   Set pointer address to 0 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 print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -101,11 +101,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 15bce8c..1804050 100644 (file)
@@ -51,11 +51,11 @@ extern "C" {
  *   This only stores comments found within valid content only.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -106,11 +106,11 @@ extern "C" {
  *   The buffer where the content is written to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
index 87acdfc..03e2b38 100644 (file)
@@ -55,11 +55,11 @@ extern "C" {
  *   This only stores comments found within valid content only.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *
@@ -124,11 +124,11 @@ extern "C" {
  *   The buffer to append to.
  * @param state
  *   A state for providing flags and handling interrupts during long running operations.
- *   There is no print_error().
- *   There is no functions structure.
+ *   There is no state.handle().
+ *   There is no "callbacks" structure.
  *   There is no data structure passed to these functions.
  *
- *   When interrupt() returns, only F_interrupt and F_interrupt_not are processed.
+ *   When state.interrupt() returns, only F_interrupt and F_interrupt_not are processed.
  *   Error bit designates an error but must be passed along with F_interrupt.
  *   All other statuses are ignored.
  *