Skip to content

Commit 88e3234

Browse files
committed
Apply feedback from review
1 parent 4e8095f commit 88e3234

File tree

26 files changed

+845
-855
lines changed

26 files changed

+845
-855
lines changed

xml/System.Runtime.ExceptionServices/ExceptionHandling.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
<Parameter Name="exception" Type="System.Object" />
4444
</Parameters>
4545
<Docs>
46-
<param name="exception">Exception to pass to event handlers.</param>
46+
<param name="exception">The exception to pass to event handlers.</param>
4747
<summary>Raises the <see cref="E:System.AppDomain.UnhandledException" /> event.</summary>
4848
<remarks>
4949
<para>This method will raise the <see cref="E:System.AppDomain.UnhandledException" /> event and then return.</para>
@@ -79,8 +79,8 @@
7979
<para>If the handler returns <see langword="false" />, the exception will continue to propagate as unhandled.</para>
8080
<para>The intent of this handler is to allow the user to handle unhandled exceptions gracefully when the runtime is being used in certain scenarios. Scenarios such as REPLs or game scripting that host plug-ins are not able to handle unhandled exceptions thrown by those plug-ins.</para>
8181
</remarks>
82-
<exception cref="T:System.ArgumentNullException">If handler is null</exception>
83-
<exception cref="T:System.InvalidOperationException">If a handler is already set</exception>
82+
<exception cref="T:System.ArgumentNullException"><paramref name="handler" /> is <see langword="null" />.</exception>
83+
<exception cref="T:System.InvalidOperationException">A handler has already been set.</exception>
8484
</Docs>
8585
</Member>
8686
</Members>

xml/System.Runtime.InteropServices.Java/ComponentCrossReference.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
<ReturnType>System.UIntPtr</ReturnType>
4545
</ReturnValue>
4646
<Docs>
47-
<summary>Index of the destination group.</summary>
47+
<summary>Specifies the index of the destination group.</summary>
4848
<remarks>To be added.</remarks>
4949
</Docs>
5050
</Member>
@@ -64,7 +64,7 @@
6464
<ReturnType>System.UIntPtr</ReturnType>
6565
</ReturnValue>
6666
<Docs>
67-
<summary>Index of the source group.</summary>
67+
<summary>Specifies the index of the source group.</summary>
6868
<remarks>To be added.</remarks>
6969
</Docs>
7070
</Member>

xml/System.Runtime.InteropServices.Java/StronglyConnectedComponent.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
<ReturnType>System.UIntPtr</ReturnType>
6666
</ReturnValue>
6767
<Docs>
68-
<summary>Number of objects in each collection.</summary>
68+
<summary>Specifies the number of objects in each collection.</summary>
6969
<remarks>To be added.</remarks>
7070
</Docs>
7171
</Member>

xml/System.Runtime.InteropServices/CollectionsMarshal.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@
5656
</Parameters>
5757
<Docs>
5858
<param name="array">The <see cref="T:System.Collections.BitArray" /> whose backing storage should be viewed.</param>
59-
<summary>Get a <see cref="T:System.Span`1" /> view over a <see cref="T:System.Collections.BitArray" />'s data.</summary>
59+
<summary>Gets a <see cref="T:System.Span`1" /> view over a <see cref="T:System.Collections.BitArray" />'s data.</summary>
6060
<returns>To be added.</returns>
61-
<remarks>&lt;para&gt;&lt;para&gt; The &lt;see cref="T:System.Collections.BitArray" /&gt; may have more capacity than is required to store the number of bits represented by &lt;see cref="P:System.Collections.BitArray.Length" /&gt;. The returned span's &lt;see cref="P:System.Span`1.Length" /&gt; will be the smallest number of bytes capable of representing that length. If the &lt;see cref="T:System.Collections.BitArray" /&gt;'s length is not evenly divisible by 8, the last byte of the span may contain extraneous bits that do not represent elements in the &lt;see cref="T:System.Collections.BitArray" /&gt;.&lt;/para&gt;&lt;para&gt;These may be ignored.&lt;/para&gt;&lt;para&gt;&lt;/para&gt;&lt;para&gt; The length of the &lt;see cref="T:System.Collections.BitArray" /&gt; should not be changed while the resulting &lt;see cref="T:System.Span`1" /&gt; is in use. After such a change, the span may no longer refer to the &lt;see cref="T:System.Collections.BitArray" /&gt;'s backing storage.&lt;/para&gt;&lt;para&gt;&lt;/para&gt;</remarks>
61+
<remarks><para>The <see cref="T:System.Collections.BitArray" /> may have more capacity than is required to store the number of bits represented by <see cref="P:System.Collections.BitArray.Length" />.</para><para>The returned span's <see cref="P:System.Span`1.Length" /> will be the smallest number of bytes capable of representing that length. If the <see cref="T:System.Collections.BitArray" />'s length is not evenly divisible by 8, the last byte of the span may contain extraneous bits that do not represent elements in the <see cref="T:System.Collections.BitArray" />.</para><para>These may be ignored.</para><para></para><para> The length of the <see cref="T:System.Collections.BitArray" /> should not be changed while the resulting <see cref="T:System.Span`1" /> is in use. After such a change, the span may no longer refer to the <see cref="T:System.Collections.BitArray" />'s backing storage.</para></remarks>
6262
</Docs>
6363
</Member>
6464
<Member MemberName="AsSpan&lt;T&gt;">

xml/System.Runtime.InteropServices/ComWrappers.xml

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -188,15 +188,15 @@ If the object cannot be created and `null` is returned, the call to <xref:System
188188
<Parameter Name="wrapperFlags" Type="System.Runtime.InteropServices.CreatedWrapperFlags" RefType="out" Index="3" FrameworkAlternate="net-10.0" />
189189
</Parameters>
190190
<Docs>
191-
<param name="externalComObject">Object to import for usage into the .NET runtime.</param>
192-
<param name="flags">Flags used to describe the external object.</param>
193-
<param name="userState">User state provided by the call to <see cref="M:System.Runtime.InteropServices.ComWrappers.GetOrCreateObjectForComInstance(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags,System.Object)" />.</param>
194-
<param name="wrapperFlags">Flags used to describe the created wrapper object.</param>
195-
<summary>Create a managed object for the object pointed at by <paramref name="externalComObject" /> respecting the values of <paramref name="flags" />.</summary>
191+
<param name="externalComObject">The object to import for usage into the .NET runtime.</param>
192+
<param name="flags">A bitwise combination of the enumeration values that describes the external object.</param>
193+
<param name="userState">The user state provided by the call to <see cref="M:System.Runtime.InteropServices.ComWrappers.GetOrCreateObjectForComInstance(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags,System.Object)" />.</param>
194+
<param name="wrapperFlags">When this method returns, contains the flags used to describe the created wrapper object.</param>
195+
<summary>Creates a managed object for the object pointed at by <paramref name="externalComObject" /> respecting the values of <paramref name="flags" />.</summary>
196196
<returns>Returns a managed object associated with the supplied external COM object.</returns>
197197
<remarks>
198198
<para>The default implementation throws <see cref="T:System.NotImplementedException" />.</para>
199-
<para>If the object cannot be created and <code>null</code> is returned, the call to <see cref="M:System.Runtime.InteropServices.ComWrappers.GetOrCreateObjectForComInstance(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags,System.Object)" /> will throw a <see cref="T:System.ArgumentNullException" />.</para>
199+
<para>If the object can't be created and <code>null</code> is returned, the call to <see cref="M:System.Runtime.InteropServices.ComWrappers.GetOrCreateObjectForComInstance(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags,System.Object)" /> will throw an <see cref="T:System.ArgumentNullException" />.</para>
200200
</remarks>
201201
</Docs>
202202
</Member>
@@ -353,14 +353,13 @@ If a managed object was previously created for the specified `externalComObject`
353353
</Parameter>
354354
</Parameters>
355355
<Docs>
356-
<param name="externalComObject">Object to import for usage into the .NET runtime.</param>
357-
<param name="flags">Flags used to describe the external object.</param>
356+
<param name="externalComObject">The object to import for usage into the .NET runtime.</param>
357+
<param name="flags">A bitwise combination of the enumeration values that describes the external object.</param>
358358
<param name="userState">A state object to use to help create the wrapping .NET object.</param>
359-
<summary>Get the currently registered managed object or creates a new managed object and registers it.</summary>
359+
<summary>Gets the currently registered managed object or creates a new managed object and registers it.</summary>
360360
<returns>Returns a managed object associated with the supplied external COM object.</returns>
361361
<remarks>
362-
<para>If a managed object was previously created for the specified <paramref name="externalComObject" /> using this <see cref="T:System.Runtime.InteropServices.ComWrappers" /> instance, the previously created object will be returned.</para>
363-
<para>If not, a new one will be created.</para>
362+
If a managed object was previously created for the specified <paramref name="externalComObject" /> using this <see cref="T:System.Runtime.InteropServices.ComWrappers" /> instance, the previously created object is returned. If not, a new one is created.
364363
</remarks>
365364
</Docs>
366365
</Member>

xml/System.Runtime.InteropServices/CreatedWrapperFlags.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</Attribute>
2020
</Attributes>
2121
<Docs>
22-
<summary>Enumeration of flags for <see cref="M:System.Runtime.InteropServices.ComWrappers.CreateObject(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags,System.Object,System.Runtime.InteropServices.CreatedWrapperFlags@)" />.</summary>
22+
<summary>Specifies flags for <see cref="M:System.Runtime.InteropServices.ComWrappers.CreateObject(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags,System.Object,System.Runtime.InteropServices.CreatedWrapperFlags@)" />.</summary>
2323
<remarks>To be added.</remarks>
2424
</Docs>
2525
<Members>
@@ -60,7 +60,7 @@
6060
</ReturnValue>
6161
<MemberValue>2</MemberValue>
6262
<Docs>
63-
<summary>The managed object doesn't keep the native object alive. It represents an equivalent value.</summary>
63+
<summary>A managed object that doesn't keep the native object alive. The managed object represents an equivalent value.</summary>
6464
</Docs>
6565
</Member>
6666
<Member MemberName="TrackerObject">
@@ -80,7 +80,7 @@
8080
</ReturnValue>
8181
<MemberValue>1</MemberValue>
8282
<Docs>
83-
<summary>Indicate if the supplied external COM object implements the <see href="https://learn.microsoft.com/windows/win32/api/windows.ui.xaml.hosting.referencetracker/nn-windows-ui-xaml-hosting-referencetracker-ireferencetracker">IReferenceTracker</see>.</summary>
83+
<summary>The supplied external COM object implements the <see href="https://learn.microsoft.com/windows/win32/api/windows.ui.xaml.hosting.referencetracker/nn-windows-ui-xaml-hosting-referencetracker-ireferencetracker">IReferenceTracker</see>.</summary>
8484
</Docs>
8585
</Member>
8686
</Members>

xml/System.Runtime.InteropServices/GCHandleExtensions.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@
5959
</Parameters>
6060
<Docs>
6161
<typeparam name="T">To be added.</typeparam>
62-
<param name="handle">The handle to retrieve pointer from.</param>
63-
<summary>Retrieves the address of array data in <paramref name="handle" />.</summary>
62+
<param name="handle">The handle to retrieve the pointer from.</param>
63+
<summary>Retrieves the address of the array data in <paramref name="handle" />.</summary>
6464
<returns>
65-
<para>The address of 0th array element the pinned array, or <see langword="null" /> if the handle doesn't point to any object.</para>
65+
<para>The address of the 0th array element of the pinned array, or <see langword="null" /> if the handle doesn't point to any object.</para>
6666
</returns>
6767
<remarks>To be added.</remarks>
68-
<exception cref="T:System.NullReferenceException">If the handle is not initialized or already disposed.</exception>
68+
<exception cref="T:System.NullReferenceException">The handle is not initialized or is already disposed.</exception>
6969
</Docs>
7070
</Member>
7171
<Member MemberName="GetAddressOfStringData">
@@ -92,13 +92,13 @@
9292
<Parameter Name="handle" Type="System.Runtime.InteropServices.PinnedGCHandle&lt;System.String&gt;" RefType="this" />
9393
</Parameters>
9494
<Docs>
95-
<param name="handle">The handle to retrieve pointer from.</param>
96-
<summary>Retrieves the address string data in <paramref name="handle" />.</summary>
95+
<param name="handle">The handle to retrieve the pointer from.</param>
96+
<summary>Retrieves the address of the string data in <paramref name="handle" />.</summary>
9797
<returns>
98-
<para>The address of 0th character of the pinned <see cref="T:System.String" />, or <see langword="null" /> if the handle doesn't point to any object.</para>
98+
<para>The address of the 0th character of the pinned <see cref="T:System.String" />, or <see langword="null" /> if the handle doesn't point to any object.</para>
9999
</returns>
100100
<remarks>To be added.</remarks>
101-
<exception cref="T:System.NullReferenceException">If the handle is not initialized or already disposed.</exception>
101+
<exception cref="T:System.NullReferenceException">The handle is not initialized or is already disposed.</exception>
102102
</Docs>
103103
</Member>
104104
</Members>

xml/System.Runtime.InteropServices/GCHandle`1.xml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,8 @@
4141
</Attributes>
4242
<Docs>
4343
<typeparam name="T">The type of the object this <see cref="T:System.Runtime.InteropServices.GCHandle`1" /> tracks to.</typeparam>
44-
<summary>
45-
<para>Represents a strongly-typed GC handle to a managed object.</para>
46-
<para>A GC handle is used to work with object references in unmanaged code.</para>
47-
</summary>
48-
<remarks>&lt;para&gt;&lt;para&gt;This type corresponds to &lt;see cref="F:System.Runtime.InteropServices.GCHandleType.Normal" /&gt;.&lt;/para&gt;&lt;para&gt; This type is unsafe if used incorrectly. Incorrect usage like mismanagement of lifetime, providing invalid handle value or concurrent disposal can result in hard to diagnose crashes or data corruptions.&lt;/para&gt;&lt;para&gt;&lt;/para&gt;</remarks>
44+
<summary>Represents a strongly typed GC handle to a managed object.</summary>
45+
<remarks><para>A GC handle is used to work with object references in unmanaged code.</para><para>This type corresponds to <see cref="F:System.Runtime.InteropServices.GCHandleType.Normal" />.</para><para>This type is unsafe if used incorrectly. Incorrect usage like mismanagement of lifetime, providing invalid handle value, or concurrent disposal can result in hard to diagnose crashes or data corruptions.</para></remarks>
4946
<seealso cref="T:System.Runtime.InteropServices.GCHandle" />
5047
</Docs>
5148
<Members>
@@ -203,7 +200,7 @@
203200
<param name="value">An <see cref="T:System.IntPtr" /> handle to a managed object to create a <see cref="T:System.Runtime.InteropServices.GCHandle`1" /> object from.</param>
204201
<summary>Returns a new <see cref="T:System.Runtime.InteropServices.GCHandle`1" /> object created from a handle to a managed object.</summary>
205202
<returns>A new <see cref="T:System.Runtime.InteropServices.GCHandle`1" /> object that corresponds to the value parameter.</returns>
206-
<remarks>&lt;para&gt;&lt;para&gt;This method doesn't validate the provided handle value. The caller must ensure the validity of the handle.&lt;/para&gt;&lt;para&gt; The &lt;see cref="T:System.IntPtr" /&gt; representation of &lt;see cref="T:System.Runtime.InteropServices.GCHandle`1" /&gt; is not interchangable with &lt;see cref="T:System.Runtime.InteropServices.GCHandle" /&gt;.&lt;/para&gt;&lt;para&gt;&lt;/para&gt;</remarks>
203+
<remarks><para><para>This method doesn't validate the provided handle value. The caller must ensure the validity of the handle.</para><para> The <see cref="T:System.IntPtr" /> representation of <see cref="T:System.Runtime.InteropServices.GCHandle`1" /> is not interchangable with <see cref="T:System.Runtime.InteropServices.GCHandle" />.</para><para></para></remarks>
207204
</Docs>
208205
</Member>
209206
<Member MemberName="GetHashCode">
@@ -256,7 +253,7 @@
256253
<ReturnType>System.Boolean</ReturnType>
257254
</ReturnValue>
258255
<Docs>
259-
<summary>Determine whether this handle has been allocated or not.</summary>
256+
<summary>Gets a value that indicates whether this handle has been allocated or not.</summary>
260257
<value>To be added.</value>
261258
<remarks>To be added.</remarks>
262259
</Docs>
@@ -290,7 +287,7 @@
290287
<summary>Gets or sets the object this handle represents.</summary>
291288
<value>To be added.</value>
292289
<remarks>To be added.</remarks>
293-
<exception cref="T:System.NullReferenceException">If the handle is not initialized or already disposed.</exception>
290+
<exception cref="T:System.NullReferenceException">The handle is not initialized or already disposed.</exception>
294291
</Docs>
295292
</Member>
296293
<Member MemberName="ToIntPtr">

0 commit comments

Comments
 (0)