Skip to content

Commit

Permalink
add doc for error checking
Browse files Browse the repository at this point in the history
  • Loading branch information
mkorbel1 committed Jan 18, 2024
1 parent 963a877 commit 05ae8ed
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lib/src/error_checking/error_checker.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
import 'package:meta/meta.dart';
import 'package:rohd/rohd.dart';

/// A transmitter for data which includes a [code] for checking and possibly
/// correcting data at the receiving end.
abstract class ErrorCheckingTransmitter extends Module {
/// The code that in addition to original data that enables error detection.
late final Logic code = output('code');
Expand Down Expand Up @@ -40,6 +42,8 @@ abstract class ErrorCheckingTransmitter extends Module {
}
}

/// A receiver for data which includes a [code] for checking and possibly
/// correcting.
abstract class ErrorCheckingReceiver extends Module {
/// Whether or not there was an error (correctable or uncorrectable).
Logic get error => output('error');
Expand Down

0 comments on commit 05ae8ed

Please sign in to comment.