Skip to content

Commit c2f1760

Browse files
committed
System.Runtime.InteropServices docs
1 parent 22c7e8c commit c2f1760

File tree

4 files changed

+29
-11
lines changed

4 files changed

+29
-11
lines changed

xml/System.Runtime.InteropServices.JavaScript/JSObject.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@
8989
<returns>The value of the property with the specified name.</returns>
9090
<remarks>This method throws a <see cref="T:System.Runtime.InteropServices.JavaScript.JSException" /> when the property value is not a Boolean.</remarks>
9191
<exception cref="T:System.Runtime.InteropServices.JavaScript.JSException">The property value is not a <see cref="T:System.Boolean" />.</exception>
92+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.GetTypeOfProperty(System.String)" />
93+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.HasProperty(System.String)" />
9294
</Docs>
9395
</Member>
9496
<Member MemberName="GetPropertyAsByteArray">
@@ -124,6 +126,8 @@
124126
<returns>The value of the property with the specified name.</returns>
125127
<remarks>This method throws a <see cref="T:System.Runtime.InteropServices.JavaScript.JSException" /> when the property value is not an array.</remarks>
126128
<exception cref="T:System.Runtime.InteropServices.JavaScript.JSException">The property value is not an array.</exception>
129+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.GetTypeOfProperty(System.String)" />
130+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.HasProperty(System.String)" />
127131
</Docs>
128132
</Member>
129133
<Member MemberName="GetPropertyAsDouble">
@@ -153,6 +157,8 @@
153157
<returns>The value of the property with the specified name.</returns>
154158
<remarks>This method throws a <see cref="T:System.Runtime.InteropServices.JavaScript.JSException" /> when the property value is not a number.</remarks>
155159
<exception cref="T:System.Runtime.InteropServices.JavaScript.JSException">The property value is not a number.</exception>
160+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.GetTypeOfProperty(System.String)" />
161+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.HasProperty(System.String)" />
156162
</Docs>
157163
</Member>
158164
<Member MemberName="GetPropertyAsInt32">
@@ -182,6 +188,8 @@
182188
<returns>The value of the property with the specified name.</returns>
183189
<remarks>This method throws a <see cref="T:System.Runtime.InteropServices.JavaScript.JSException" /> when the property value is not an integer.</remarks>
184190
<exception cref="T:System.Runtime.InteropServices.JavaScript.JSException">The property value is not an integer.</exception>
191+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.GetTypeOfProperty(System.String)" />
192+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.HasProperty(System.String)" />
185193
</Docs>
186194
</Member>
187195
<Member MemberName="GetPropertyAsJSObject">
@@ -217,6 +225,8 @@
217225
<returns>The value of the property with the specified name.</returns>
218226
<remarks>This method throws a <see cref="T:System.Runtime.InteropServices.JavaScript.JSException" /> when the property value is not an object.</remarks>
219227
<exception cref="T:System.Runtime.InteropServices.JavaScript.JSException">The property value is not a <see cref="T:System.Runtime.InteropServices.JavaScript.JSObject" />.</exception>
228+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.GetTypeOfProperty(System.String)" />
229+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.HasProperty(System.String)" />
220230
</Docs>
221231
</Member>
222232
<Member MemberName="GetPropertyAsString">
@@ -252,6 +262,8 @@
252262
<returns>The value of the property with the specified name.</returns>
253263
<remarks>This method throws a <see cref="T:System.Runtime.InteropServices.JavaScript.JSException" /> when the property value is not a string.</remarks>
254264
<exception cref="T:System.Runtime.InteropServices.JavaScript.JSException">The property value is not a string.</exception>
265+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.GetTypeOfProperty(System.String)" />
266+
<seealso cref="M:System.Runtime.InteropServices.JavaScript.JSObject.HasProperty(System.String)" />
255267
</Docs>
256268
</Member>
257269
<Member MemberName="GetTypeOfProperty">

xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@
6565
<ReturnType>System.Type</ReturnType>
6666
</ReturnValue>
6767
<Docs>
68-
<summary>To be added.</summary>
68+
<summary>Gets or sets the <see cref="T:System.Type" /> used to control how exceptions are marshalled for all methods on the interface.</summary>
6969
<value>To be added.</value>
70-
<remarks>To be added.</remarks>
70+
<remarks>If this field is not specified, <see cref="T:System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller`1" /> is used to marshal exceptions.</remarks>
7171
</Docs>
7272
</Member>
7373
<Member MemberName="Options">

xml/System.Runtime.InteropServices.Marshalling/StrategyBasedComWrappers.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@
101101
<returns>
102102
<see cref="T:System.Runtime.InteropServices.ComWrappers.ComInterfaceEntry" /> pointer containing memory for all COM interface entries.</returns>
103103
<remarks>To be added.</remarks>
104+
<inheritdoc cref="M:System.Runtime.InteropServices.ComWrappers.ComputeVtables(System.Object,System.Runtime.InteropServices.CreateComInterfaceFlags,System.Int32@)" />
104105
</Docs>
105106
</Member>
106107
<Member MemberName="CreateCacheStrategy">
@@ -210,6 +211,7 @@
210211
<summary>To be added.</summary>
211212
<returns>To be added.</returns>
212213
<remarks>To be added.</remarks>
214+
<inheritdoc cref="M:System.Runtime.InteropServices.ComWrappers.CreateObject(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags,System.Object,System.Runtime.InteropServices.CreatedWrapperFlags@)" />
213215
</Docs>
214216
</Member>
215217
<Member MemberName="DefaultIUnknownInterfaceDetailsStrategy">

xml/System.Runtime.InteropServices/JsonMarshal.xml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
</Base>
1616
<Interfaces />
1717
<Docs>
18-
<summary>To be added.</summary>
18+
<summary>An unsafe class that provides a set of methods to access the underlying data representations of JSON types.</summary>
1919
<remarks>To be added.</remarks>
2020
</Docs>
2121
<Members>
@@ -38,10 +38,11 @@
3838
<Parameter Name="property" Type="System.Text.Json.JsonProperty" Index="0" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
3939
</Parameters>
4040
<Docs>
41-
<param name="property">To be added.</param>
42-
<summary>To be added.</summary>
43-
<returns>To be added.</returns>
44-
<remarks>To be added.</remarks>
41+
<param name="property">The JSON property from which to extract the span.</param>
42+
<summary>Gets a <see cref="T:System.ReadOnlySpan`1" /> view over the raw JSON data of the given <see cref="T:System.Text.Json.JsonProperty" /> name.</summary>
43+
<returns>The span containing the raw JSON data of the <paramref name="property" /> name. This will not include the enclosing quotes.</returns>
44+
<remarks>&lt;para&gt;&lt;para&gt; While the method itself does check for disposal of the underlying &lt;see cref="T:System.Text.Json.JsonDocument" /&gt;, it is possible that it could be disposed after the method returns, which would result in the span pointing to a buffer that has been returned to the shared pool. Callers should take extra care to make sure that such a scenario isn't possible to avoid potential data corruption.&lt;/para&gt;&lt;para&gt;&lt;/para&gt;</remarks>
45+
<exception cref="T:System.ObjectDisposedException">The underlying <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
4546
</Docs>
4647
</Member>
4748
<Member MemberName="GetRawUtf8Value">
@@ -64,10 +65,13 @@
6465
<Parameter Name="element" Type="System.Text.Json.JsonElement" />
6566
</Parameters>
6667
<Docs>
67-
<param name="element">To be added.</param>
68-
<summary>To be added.</summary>
69-
<returns>To be added.</returns>
70-
<remarks>To be added.</remarks>
68+
<param name="element">The JSON element from which to extract the span.</param>
69+
<summary>Gets a <see cref="T:System.ReadOnlySpan`1" /> view over the raw JSON data of the given <see cref="T:System.Text.Json.JsonElement" />.</summary>
70+
<returns>The span containing the raw JSON data of<paramref name="element" />.</returns>
71+
<remarks>
72+
<para>While the method itself does check for disposal of the underlying <see cref="T:System.Text.Json.JsonDocument" />, it is possible that it could be disposed after the method returns, which would result in the span pointing to a buffer that has been returned to the shared pool. Callers should take extra care to make sure that such a scenario isn't possible to avoid potential data corruption.</para>
73+
</remarks>
74+
<exception cref="T:System.ObjectDisposedException">The underlying <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
7175
</Docs>
7276
</Member>
7377
</Members>

0 commit comments

Comments
 (0)