]> Kevux Git Server - fll/commitdiff
Cleanup: Documentation comments in regards to f_state_t.
authorKevin Day <kevin@kevux.org>
Tue, 7 Mar 2023 00:33:14 +0000 (18:33 -0600)
committerKevin Day <kevin@kevux.org>
Tue, 7 Mar 2023 00:33:14 +0000 (18:33 -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 784420d8dd2c6261cca48416d3a92b38ac652228..69e91a828304f4ac860241cdadb1459a1839d88e 100644 (file)
@@ -136,11 +136,11 @@ extern "C" {
  *
  * @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.
  * @param buffer
index b729a784ad32894abb15d9f6b54889451b27e26d..123c61f966ac6845c84dda384109844a56cad280 100644 (file)
@@ -38,11 +38,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -100,11 +100,11 @@ extern "C" {
  *   If f_fss_complete_full_e, this will write any appropriate open and close aspects of this content, including the final 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.
  * @param range
@@ -143,11 +143,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -223,11 +223,11 @@ extern "C" {
  *   If f_fss_complete_partial_tim, this will write any appropriate open and close aspects of this object, but will omit whitespace before and after the object (inside the quotes).
  * @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.
  * @param range
index e6288f646ee2fea784396a3780525e95a1f4aaef..205835bf7faee6fb36a02aac55642ff7b053c97a 100644 (file)
@@ -39,11 +39,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -115,11 +115,11 @@ extern "C" {
  *   Set the pointer address to 0 to disable.
  * @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.
  * @param range
@@ -167,11 +167,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -238,11 +238,11 @@ extern "C" {
  *   If f_fss_complete_partial_tim, this will write any appropriate open and close aspects of this object, but will omit whitespace before and after the object.
  * @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.
  * @param range
index 27d6cfd115b2f078fee0f1a8c6e1d262ab67e77b..f754f51c40f33ab4def74c1234d4b9f798d2b0fa 100644 (file)
@@ -43,11 +43,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -126,11 +126,11 @@ extern "C" {
  *   Set the pointer address to 0 to disable.
  * @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.
  * @param range
@@ -177,11 +177,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -248,11 +248,11 @@ extern "C" {
  *   If f_fss_complete_partial_tim, this will write any appropriate open and close aspects of this object, but will omit whitespace before and after the object.
  * @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.
  * @param range
index 88b8651ac31a75765cad2ab5bbba70e3d3a248a7..c407fbc8a52343477025bd2827c6aa1f96f81745 100644 (file)
@@ -38,11 +38,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -117,11 +117,11 @@ extern "C" {
  *   If f_fss_complete_full_e, this will write any appropriate open and close aspects of this content, including the final 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.
  * @param range
@@ -170,11 +170,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -253,11 +253,11 @@ extern "C" {
  *   If f_fss_complete_partial_e, this will write any appropriate open and close aspects of this object.
  * @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.
  * @param range
index 11ef37426f36073a9d56f1f76dcae4867073cae3..9391a43722b433caa2e1bd9c683e09c82a8ae00d 100644 (file)
@@ -41,11 +41,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -122,11 +122,11 @@ extern "C" {
  *   Set the pointer address to 0 to disable.
  * @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.
  * @param range
@@ -173,11 +173,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -244,11 +244,11 @@ extern "C" {
  *   If f_fss_complete_partial_tim, this will write any appropriate open and close aspects of this object, but will omit whitespace before and after the object.
  * @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.
  * @param range
index d3747aa1731a10eb8a4da4ccbcfcb1e6c7677740..b8308d2078629a7a5095abf09b2f1cf034d2820f 100644 (file)
@@ -22,11 +22,11 @@ extern "C" {
  *   The buffer to seek through.
  * @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.
  * @param range
@@ -57,11 +57,11 @@ extern "C" {
  *   The destination.used value before any operations were performed.
  * @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.
  * @param destination
@@ -97,11 +97,11 @@ extern "C" {
  *   As Content, this does nothing special in regards to a leading '#'.
  * @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.
  * @param range
@@ -178,11 +178,11 @@ extern "C" {
  *   Otherwise, this is the type of quote to wrap the object in when writing.
  * @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.
  * @param range
@@ -232,11 +232,11 @@ extern "C" {
  *   The destination.used value before any operations were perfomed.
  * @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.
  * @param destination
index 67ab64947307aa00cd19c2a5389dea1843de7ad2..d4043430cb3ec858685ef3741239ffebe169cc73 100644 (file)
@@ -34,11 +34,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -97,11 +97,11 @@ extern "C" {
  *   Otherwise, this is the type of quote to wrap the object in when writing.
  * @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.
  * @param destination
index e17143dbe3c9b40b998435d5e79bd4b006b20a12..e7617efcc35f8f05162a1cde5b4fa1dd7cbad217 100644 (file)
@@ -34,11 +34,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -96,11 +96,11 @@ extern "C" {
  *   Set the pointer address to 0 to disable.
  * @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.
  * @param destination
index faf221e421a069a6079d610e26fdc540a7f58607..f45ecdcec292212a9de5a9c303dd01a3ea3a0043 100644 (file)
@@ -33,11 +33,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -100,11 +100,11 @@ extern "C" {
  *   Set the pointer address to 0 to disable.
  * @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.
  * @param destination
index f91da6bb62daab65c703df2742923fecbbb6f70f..6dcf9394de74fa308e27855e673000e35ae08b95 100644 (file)
@@ -33,11 +33,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -99,11 +99,11 @@ extern "C" {
  *   Otherwise, this is the type of quote to wrap the object in when writing.
  * @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.
  * @param destination
index b18bb9428306f92eaa3935301f498d6db7073ace..3b250a0b41f14b74fa84c37018f16a2dfb0e6f0e 100644 (file)
@@ -35,11 +35,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -104,11 +104,11 @@ extern "C" {
  *   Set the pointer address to 0 to disable.
  * @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.
  * @param destination
index bdaf15a69db54ca093a364b98df7f2c1cb9d1c42..cebb19cca97371c0f5394d08de3c290111fabbfe 100644 (file)
@@ -39,11 +39,11 @@ extern "C" {
  *   The buffer to read from.
  * @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.
  * @param range
@@ -122,11 +122,11 @@ extern "C" {
  *   Set the pointer address to 0 to disable.
  * @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.
  * @param destination