Skip to content

Commit 270c747

Browse files
authored
missing docs for System.Runtime.InteropServices.JavaScript (#8436)
1 parent b5871f7 commit 270c747

13 files changed

+530
-527
lines changed

xml/System.Runtime.InteropServices.JavaScript/JSFunctionBinding.xml

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
</AssemblyInfo>
4747
<Parameters />
4848
<Docs>
49-
<summary>To be added.</summary>
49+
<summary>This API supports JSImport infrastructure and is not intended to be used directly from your code.</summary>
5050
<remarks>To be added.</remarks>
5151
</Docs>
5252
</Member>
@@ -71,13 +71,14 @@
7171
<Parameter Name="signatures" Type="System.ReadOnlySpan&lt;System.Runtime.InteropServices.JavaScript.JSMarshalerType&gt;" />
7272
</Parameters>
7373
<Docs>
74-
<param name="functionName">To be added.</param>
75-
<param name="moduleName">To be added.</param>
76-
<param name="signatures">To be added.</param>
74+
<param name="functionName">The name of the exported JavaScript function.</param>
75+
<param name="moduleName">The name of the ES6 module.</param>
76+
<param name="signatures">Metadata about the signature of the marshalled parameters.</param>
7777
<summary>Locates and binds a JavaScript function given name and module so that it can later be invoked by managed callers.
7878
This API supports JSImport infrastructure and is not intended to be used directly from your code.</summary>
79-
<returns>To be added.</returns>
79+
<returns>Method metadata.</returns>
8080
<remarks>To be added.</remarks>
81+
<exception cref="T:System.PlatformNotSupportedException">The method was executed on architecture other than WebAssembly.</exception>
8182
</Docs>
8283
</Member>
8384
<Member MemberName="BindManagedFunction">
@@ -101,13 +102,14 @@
101102
<Parameter Name="signatures" Type="System.ReadOnlySpan&lt;System.Runtime.InteropServices.JavaScript.JSMarshalerType&gt;" />
102103
</Parameters>
103104
<Docs>
104-
<param name="fullyQualifiedName">To be added.</param>
105-
<param name="signatureHash">To be added.</param>
106-
<param name="signatures">To be added.</param>
105+
<param name="fullyQualifiedName">The fully qualified name of the exported method.</param>
106+
<param name="signatureHash">The hash of the signature metadata.</param>
107+
<param name="signatures">Metadata about the signature of the marshalled parameters.</param>
107108
<summary>Binds a specific managed function wrapper so that it can later be invoked by JavaScript callers.
108109
This API supports JSImport infrastructure and is not intended to be used directly from your code.</summary>
109-
<returns>To be added.</returns>
110+
<returns>Method metadata.</returns>
110111
<remarks>To be added.</remarks>
112+
<exception cref="T:System.PlatformNotSupportedException">The method was executed on architecture other than WebAssembly.</exception>
111113
</Docs>
112114
</Member>
113115
<Member MemberName="InvokeJS">
@@ -130,8 +132,8 @@
130132
<Parameter Name="arguments" Type="System.Span&lt;System.Runtime.InteropServices.JavaScript.JSMarshalerArgument&gt;" />
131133
</Parameters>
132134
<Docs>
133-
<param name="signature">To be added.</param>
134-
<param name="arguments">To be added.</param>
135+
<param name="signature">Generated metadata about the method signature used for marshaling.</param>
136+
<param name="arguments">The intermediate buffer with marshalled arguments.</param>
135137
<summary>Invokes a previously bound JavaScript function using the provided span to transport argument and return values.
136138
This API supports JSImport infrastructure and is not intended to be used directly from your code.</summary>
137139
<remarks>To be added.</remarks>

xml/System.Runtime.InteropServices.JavaScript/JSMarshalerArgument+ArgumentToJSCallback`1.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
<ReturnType>System.Void</ReturnType>
2424
</ReturnValue>
2525
<Docs>
26-
<typeparam name="T">To be added.</typeparam>
27-
<param name="arg">To be added.</param>
28-
<param name="value">To be added.</param>
26+
<typeparam name="T">The type of the marshalled value.</typeparam>
27+
<param name="arg">The low-level argument representation.</param>
28+
<param name="value">The value to be marshalled.</param>
2929
<summary>Assists in marshalling of Task results and Function arguments.
3030
This API is used by JSImport code generator and should not be used by developers in source code.</summary>
3131
<remarks>To be added.</remarks>

xml/System.Runtime.InteropServices.JavaScript/JSMarshalerArgument+ArgumentToManagedCallback`1.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
<ReturnType>System.Void</ReturnType>
2424
</ReturnValue>
2525
<Docs>
26-
<typeparam name="T">To be added.</typeparam>
27-
<param name="arg">To be added.</param>
28-
<param name="value">To be added.</param>
26+
<typeparam name="T">The type of the marshalled value.</typeparam>
27+
<param name="arg">The low-level argument representation.</param>
28+
<param name="value">The value to be marshalled.</param>
2929
<summary>Assists in marshalling of Task results and Function arguments.
3030
This API is used by JSImport code generator and should not be used by developers in source code.</summary>
3131
<remarks>To be added.</remarks>

0 commit comments

Comments
 (0)