From 1b5393086ffaff594211d812b643fbaa3d765038 Mon Sep 17 00:00:00 2001 From: Jan Romann Date: Sat, 20 Jan 2024 21:33:09 +0100 Subject: [PATCH] docs(InteractionOutput): improve implementation documentation --- lib/src/core/implementation/interaction_output.dart | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/lib/src/core/implementation/interaction_output.dart b/lib/src/core/implementation/interaction_output.dart index 89ab1a55..6ad1971f 100644 --- a/lib/src/core/implementation/interaction_output.dart +++ b/lib/src/core/implementation/interaction_output.dart @@ -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,