Skip to content

Commit

Permalink
docs(InteractionOutput): improve implementation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JKRhb committed Jan 27, 2024
1 parent f0b4afe commit 1b53930
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions lib/src/core/implementation/interaction_output.dart
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,15 @@ import "content_serdes.dart";
class InteractionOutput implements scripting_api.InteractionOutput {
/// Creates a new [InteractionOutput] based on a [Content] object.
///
/// A [ContentSerdes] object has to be passed for decoding the raw
/// payload contained in the [Content] object.
/// A [_contentSerdes] object has to be passed for decoding the raw
/// payload contained in the [_content] object.
///
/// In contrast to the interface definition in the
/// [Scripting API specification], [_form] is defined as non-nullable here,
/// since other parts of the code never pass a `null` value as an argument for
/// this parameter.
///
/// [Scripting API specification]: https://w3c.github.io/wot-scripting-api/#the-interactionoutput-interface
InteractionOutput(
this._content,
this._contentSerdes,
Expand Down

0 comments on commit 1b53930

Please sign in to comment.