Skip to content

Commit 858e24b

Browse files
authored
fix mismatched paramrefs (#11147)
1 parent 86426cc commit 858e24b

33 files changed

+1023
-1038
lines changed

xml/System.Security.AccessControl/CompoundAce.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@
183183
<summary>Marshals the contents of the <see cref="T:System.Security.AccessControl.CompoundAce" /> object into the specified byte array beginning at the specified offset.</summary>
184184
<remarks>To be added.</remarks>
185185
<exception cref="T:System.ArgumentOutOfRangeException">
186-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.CompoundAce" /> to be copied into <paramref name="array" />.</exception>
186+
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.CompoundAce" /> to be copied into <paramref name="binaryForm" />.</exception>
187187
</Docs>
188188
</Member>
189189
</Members>

xml/System.Security.AccessControl/CustomAce.xml

+11-11
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@
3535
<Docs>
3636
<summary>Represents an Access Control Entry (ACE) that is not defined by one of the members of the <see cref="T:System.Security.AccessControl.AceType" /> enumeration.</summary>
3737
<remarks>
38-
<format type="text/markdown"><![CDATA[
39-
40-
## Remarks
41-
A <xref:System.Security.AccessControl.CustomAce> object contains an ACE header and an opaque blob of data.
42-
38+
<format type="text/markdown"><![CDATA[
39+
40+
## Remarks
41+
A <xref:System.Security.AccessControl.CustomAce> object contains an ACE header and an opaque blob of data.
42+
4343
]]></format>
4444
</remarks>
4545
</Docs>
@@ -81,11 +81,11 @@
8181
<param name="opaque">An array of byte values that contains the data for the new ACE. This value can be <see langword="null" />. The length of this array must not be greater than the value of the <see cref="F:System.Security.AccessControl.CustomAce.MaxOpaqueLength" /> field, and must be a multiple of four.</param>
8282
<summary>Initializes a new instance of the <see cref="T:System.Security.AccessControl.CustomAce" /> class.</summary>
8383
<remarks>
84-
<format type="text/markdown"><![CDATA[
85-
86-
## Remarks
87-
The `opaque` data is not cloned. The data should be cloned before calling this constructor if the caller does not trust the source of the data to not modify the data.
88-
84+
<format type="text/markdown"><![CDATA[
85+
86+
## Remarks
87+
The `opaque` data is not cloned. The data should be cloned before calling this constructor if the caller does not trust the source of the data to not modify the data.
88+
8989
]]></format>
9090
</remarks>
9191
<exception cref="T:System.ArgumentOutOfRangeException">The value of the <paramref name="type" /> parameter is not greater than <see cref="F:System.Security.AccessControl.AceType.MaxDefinedAceType" /> or the length of the <paramref name="opaque" /> array is either greater than the value of the <see cref="F:System.Security.AccessControl.CustomAce.MaxOpaqueLength" /> field or not a multiple of four.</exception>
@@ -163,7 +163,7 @@
163163
<summary>Marshals the contents of the <see cref="T:System.Security.AccessControl.CustomAce" /> object into the specified byte array beginning at the specified offset.</summary>
164164
<remarks>To be added.</remarks>
165165
<exception cref="T:System.ArgumentOutOfRangeException">
166-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.CustomAce" /> to be copied into <paramref name="array" />.</exception>
166+
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.CustomAce" /> to be copied into <paramref name="binaryForm" />.</exception>
167167
</Docs>
168168
</Member>
169169
<Member MemberName="GetOpaque">

xml/System.Security.AccessControl/FileSecurity.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ You can add access or audit rules to the <xref:System.Security.AccessControl.Fil
180180
<exception cref="T:System.IO.FileNotFoundException">The file specified in the <paramref name="fileName" /> parameter was not found.</exception>
181181
<exception cref="T:System.IO.IOException">An I/O error occurred while opening the file.</exception>
182182
<exception cref="T:System.NotSupportedException">
183-
<paramref name="path" /> is in an invalid format.</exception>
183+
<paramref name="fileName" /> is in an invalid format.</exception>
184184
<exception cref="T:System.Runtime.InteropServices.SEHException">The <paramref name="fileName" /> parameter is <see langword="null" />.</exception>
185185
<exception cref="T:System.PlatformNotSupportedException">The current operating system is not Microsoft Windows 2000 or later.</exception>
186186
<exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length. </exception>

xml/System.Security.AccessControl/GenericAce.xml

+11-11
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@
3535
<Docs>
3636
<summary>Represents an Access Control Entry (ACE), and is the base class for all other ACE classes.</summary>
3737
<remarks>
38-
<format type="text/markdown"><![CDATA[
39-
40-
## Remarks
41-
An ACE contains both an ACE header and a binary blob. The header contains information about the type of the ACE, various flags, and the size of the binary blob.
42-
38+
<format type="text/markdown"><![CDATA[
39+
40+
## Remarks
41+
An ACE contains both an ACE header and a binary blob. The header contains information about the type of the ACE, various flags, and the size of the binary blob.
42+
4343
]]></format>
4444
</remarks>
4545
</Docs>
@@ -76,11 +76,11 @@
7676
<summary>Gets or sets the <see cref="T:System.Security.AccessControl.AceFlags" /> associated with this <see cref="T:System.Security.AccessControl.GenericAce" /> object.</summary>
7777
<value>The <see cref="T:System.Security.AccessControl.AceFlags" /> associated with this <see cref="T:System.Security.AccessControl.GenericAce" /> object.</value>
7878
<remarks>
79-
<format type="text/markdown"><![CDATA[
80-
81-
## Remarks
82-
An <xref:System.Security.AccessControl.AceFlags> object contains flags that specify information about the inheritance, inheritance propagation, and auditing conditions for an Access Control Entry (ACE).
83-
79+
<format type="text/markdown"><![CDATA[
80+
81+
## Remarks
82+
An <xref:System.Security.AccessControl.AceFlags> object contains flags that specify information about the inheritance, inheritance propagation, and auditing conditions for an Access Control Entry (ACE).
83+
8484
]]></format>
8585
</remarks>
8686
</Docs>
@@ -347,7 +347,7 @@
347347
<summary>Marshals the contents of the <see cref="T:System.Security.AccessControl.GenericAce" /> object into the specified byte array beginning at the specified offset.</summary>
348348
<remarks>To be added.</remarks>
349349
<exception cref="T:System.ArgumentOutOfRangeException">
350-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.GenericAcl" /> to be copied into <paramref name="array" />.</exception>
350+
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.GenericAcl" /> to be copied into <paramref name="binaryForm" />.</exception>
351351
</Docs>
352352
</Member>
353353
<Member MemberName="GetHashCode">

xml/System.Security.AccessControl/GenericAcl.xml

+6-6
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,11 @@
105105
<Docs>
106106
<summary>The revision level of the current <see cref="T:System.Security.AccessControl.GenericAcl" />. This value is returned by the <see cref="P:System.Security.AccessControl.GenericAcl.Revision" /> property for Access Control Lists (ACLs) that are not associated with Directory Services objects.</summary>
107107
<remarks>
108-
<format type="text/markdown"><![CDATA[
109-
110-
## Remarks
111-
The revision level cannot be changed after an instance of the <xref:System.Security.AccessControl.GenericAcl> class has been created.
112-
108+
<format type="text/markdown"><![CDATA[
109+
110+
## Remarks
111+
The revision level cannot be changed after an instance of the <xref:System.Security.AccessControl.GenericAcl> class has been created.
112+
113113
]]></format>
114114
</remarks>
115115
</Docs>
@@ -295,7 +295,7 @@
295295
<summary>Marshals the contents of the <see cref="T:System.Security.AccessControl.GenericAcl" /> object into the specified byte array beginning at the specified offset.</summary>
296296
<remarks>To be added.</remarks>
297297
<exception cref="T:System.ArgumentOutOfRangeException">
298-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.GenericAcl" /> to be copied into <paramref name="array" />.</exception>
298+
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.GenericAcl" /> to be copied into <paramref name="binaryForm" />.</exception>
299299
</Docs>
300300
</Member>
301301
<Member MemberName="GetEnumerator">

xml/System.Security.AccessControl/GenericSecurityDescriptor.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@
167167
<summary>Returns an array of byte values that represents the information contained in this <see cref="T:System.Security.AccessControl.GenericSecurityDescriptor" /> object.</summary>
168168
<remarks>To be added.</remarks>
169169
<exception cref="T:System.ArgumentOutOfRangeException">
170-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.GenericSecurityDescriptor" /> to be copied into <paramref name="array" />.</exception>
170+
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.GenericSecurityDescriptor" /> to be copied into <paramref name="binaryForm" />.</exception>
171171
</Docs>
172172
</Member>
173173
<Member MemberName="GetSddlForm">

xml/System.Security.AccessControl/ObjectAce.xml

+11-11
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@
169169
<summary>Marshals the contents of the <see cref="T:System.Security.AccessControl.ObjectAce" /> object into the specified byte array beginning at the specified offset.</summary>
170170
<remarks>To be added.</remarks>
171171
<exception cref="T:System.ArgumentOutOfRangeException">
172-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.ObjectAce" /> to be copied into <paramref name="array" />.</exception>
172+
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.ObjectAce" /> to be copied into <paramref name="binaryForm" />.</exception>
173173
</Docs>
174174
</Member>
175175
<Member MemberName="InheritedObjectAceType">
@@ -204,11 +204,11 @@
204204
<summary>Gets or sets the GUID of the object type that can inherit the Access Control Entry (ACE) that this <see cref="T:System.Security.AccessControl.ObjectAce" /> object represents.</summary>
205205
<value>The GUID of the object type that can inherit the Access Control Entry (ACE) that this <see cref="T:System.Security.AccessControl.ObjectAce" /> object represents.</value>
206206
<remarks>
207-
<format type="text/markdown"><![CDATA[
208-
209-
## Remarks
210-
If the value of the <xref:System.Security.AccessControl.ObjectAce.ObjectAceFlags%2A> parameter does not contain the value <xref:System.Security.AccessControl.ObjectAceFlags.InheritedObjectAceTypePresent>, this property is ignored.
211-
207+
<format type="text/markdown"><![CDATA[
208+
209+
## Remarks
210+
If the value of the <xref:System.Security.AccessControl.ObjectAce.ObjectAceFlags%2A> parameter does not contain the value <xref:System.Security.AccessControl.ObjectAceFlags.InheritedObjectAceTypePresent>, this property is ignored.
211+
212212
]]></format>
213213
</remarks>
214214
</Docs>
@@ -317,11 +317,11 @@
317317
<summary>Gets or sets the GUID of the object type associated with this <see cref="T:System.Security.AccessControl.ObjectAce" /> object.</summary>
318318
<value>The GUID of the object type associated with this <see cref="T:System.Security.AccessControl.ObjectAce" /> object.</value>
319319
<remarks>
320-
<format type="text/markdown"><![CDATA[
321-
322-
## Remarks
323-
If the value of the <xref:System.Security.AccessControl.ObjectAce.ObjectAceFlags%2A> parameter does not contain the value <xref:System.Security.AccessControl.ObjectAceFlags.ObjectAceTypePresent>, this property is ignored.
324-
320+
<format type="text/markdown"><![CDATA[
321+
322+
## Remarks
323+
If the value of the <xref:System.Security.AccessControl.ObjectAce.ObjectAceFlags%2A> parameter does not contain the value <xref:System.Security.AccessControl.ObjectAceFlags.ObjectAceTypePresent>, this property is ignored.
324+
325325
]]></format>
326326
</remarks>
327327
</Docs>

xml/System.Security.AccessControl/ObjectAuditRule.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
<param name="auditFlags">The audit conditions.</param>
7979
<summary>Initializes a new instance of the <see cref="T:System.Security.AccessControl.ObjectAuditRule" /> class.</summary>
8080
<remarks>To be added.</remarks>
81-
<exception cref="T:System.ArgumentException">The value of the <paramref name="identity" /> parameter cannot be cast as a <see cref="T:System.Security.Principal.SecurityIdentifier" />, or the <paramref name="type" /> parameter contains an invalid value.</exception>
81+
<exception cref="T:System.ArgumentException">The value of the <paramref name="identity" /> parameter cannot be cast as a <see cref="T:System.Security.Principal.SecurityIdentifier" />, or the <paramref name="objectType" /> parameter contains an invalid value.</exception>
8282
<exception cref="T:System.ArgumentOutOfRangeException">The value of the <paramref name="accessMask" /> parameter is 0, or the <paramref name="inheritanceFlags" /> or <paramref name="propagationFlags" /> parameters contain unrecognized flag values.</exception>
8383
</Docs>
8484
</Member>

xml/System.Security.AccessControl/RawAcl.xml

+11-13
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@
3535
<Docs>
3636
<summary>Represents an Access Control List (ACL).</summary>
3737
<remarks>
38-
<format type="text/markdown"><![CDATA[
39-
40-
## Remarks
41-
The <xref:System.Security.AccessControl.RawAcl> class allows full manipulation of Access Control Entries (ACEs). It does not enforce ordering rules for ACEs and does not provide validation logic. Any ACE can be inserted, modified, or removed at any location in the ACL.
42-
38+
<format type="text/markdown"><![CDATA[
39+
40+
## Remarks
41+
The <xref:System.Security.AccessControl.RawAcl> class allows full manipulation of Access Control Entries (ACEs). It does not enforce ordering rules for ACEs and does not provide validation logic. Any ACE can be inserted, modified, or removed at any location in the ACL.
42+
4343
]]></format>
4444
</remarks>
4545
</Docs>
@@ -231,7 +231,7 @@
231231
<summary>Marshals the contents of the <see cref="T:System.Security.AccessControl.RawAcl" /> object into the specified byte array beginning at the specified offset.</summary>
232232
<remarks>To be added.</remarks>
233233
<exception cref="T:System.ArgumentOutOfRangeException">
234-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.RawAcl" /> to be copied into <paramref name="array" />.</exception>
234+
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.RawAcl" /> to be copied into <paramref name="binaryForm" />.</exception>
235235
</Docs>
236236
</Member>
237237
<Member MemberName="InsertAce">
@@ -271,15 +271,13 @@
271271
<param name="ace">The ACE to insert.</param>
272272
<summary>Inserts the specified Access Control Entry (ACE) at the specified index.</summary>
273273
<remarks>
274-
<format type="text/markdown"><![CDATA[
275-
276-
## Remarks
277-
The inserted ACE is not cloned before insertion, so any modifications to the ACE after it has been inserted are reflected in the Access Control List (ACL).
278-
274+
<format type="text/markdown"><![CDATA[
275+
276+
## Remarks
277+
The inserted ACE is not cloned before insertion, so any modifications to the ACE after it has been inserted are reflected in the Access Control List (ACL).
278+
279279
]]></format>
280280
</remarks>
281-
<exception cref="T:System.ArgumentOutOfRangeException">
282-
<paramref name="offset" /> is negative or too high to allow the entire <see cref="T:System.Security.AccessControl.GenericAcl" /> to be copied into <paramref name="array" />.</exception>
283281
</Docs>
284282
</Member>
285283
<Member MemberName="Item">

xml/System.Security.AccessControl/RegistryAccessRule.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@
163163

164164
-or-
165165

166-
<paramref name="eventRights" /> is zero.</exception>
166+
<paramref name="registryRights" /> is zero.</exception>
167167
<exception cref="T:System.ArgumentException">
168168
<paramref name="identity" /> is neither of type <see cref="T:System.Security.Principal.SecurityIdentifier" /> nor of a type such as <see cref="T:System.Security.Principal.NTAccount" /> that can be converted to type <see cref="T:System.Security.Principal.SecurityIdentifier" />.</exception>
169169
</Docs>
@@ -426,7 +426,7 @@
426426

427427
<paramref name="propagationFlags" /> specifies an invalid value.</exception>
428428
<exception cref="T:System.ArgumentNullException">
429-
<paramref name="eventRights" /> is zero.</exception>
429+
<paramref name="registryRights" /> is zero.</exception>
430430
<exception cref="T:System.ArgumentException">
431431
<paramref name="identity" /> is <see langword="null" />.
432432

0 commit comments

Comments
 (0)