From 57a303b85501d22ff1f123b1ccf91f7d128319ff Mon Sep 17 00:00:00 2001 From: Jan Romann Date: Sat, 27 Jan 2024 22:13:42 +0100 Subject: [PATCH] docs(InteractionOutput): improve interface documentation --- lib/src/core/scripting_api/interaction_output.dart | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/src/core/scripting_api/interaction_output.dart b/lib/src/core/scripting_api/interaction_output.dart index 4a8326e6..8fd66a2b 100644 --- a/lib/src/core/scripting_api/interaction_output.dart +++ b/lib/src/core/scripting_api/interaction_output.dart @@ -30,8 +30,19 @@ abstract interface class InteractionOutput { /// Asyncronously creates a [ByteBuffer] representation of the value of /// of the [InteractionOutput]. + /// + /// Follows the algorithm defined for the `arrayBuffer()` function in the + /// Scripting API specification. + /// + /// [algorithm]: https://w3c.github.io/wot-scripting-api/#the-arraybuffer-function Future arrayBuffer(); /// The parsed value of the [InteractionOutput]. + /// + /// + /// Follows the algorithm defined for the `arrayBuffer()` function in the + /// Scripting API specification. + /// + /// [algorithm]: https://w3c.github.io/wot-scripting-api/#the-value-function Future value(); }