Skip to content

Commit 50eb2f5

Browse files
authored
Fix up broken links (System.Runtime through System.Timers) (#4539)
* fix xrefs
1 parent 8049faf commit 50eb2f5

File tree

17 files changed

+61
-83
lines changed

17 files changed

+61
-83
lines changed

xml/System.Security.Cryptography.Pkcs/EnvelopedCms.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -853,7 +853,7 @@ Unlike the other overloads of `Decrypt`, this overload does not search certifica
853853
<remarks>To be added.</remarks>
854854
<exception cref="T:System.ArgumentNullException">The <paramref name="recipient" /> parameter is <see langword="null" />.</exception>
855855
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
856-
<altmember cref="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encode()" />
856+
<altmember cref="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encode" />
857857
</Docs>
858858
</Member>
859859
<Member MemberName="Encrypt">

xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
105105
<altmember cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.IsReadOnly" />
106106
<altmember cref="Overload:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey" />
107-
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportPkcs8PrivateKey()" />
107+
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportPkcs8PrivateKey" />
108108
</Docs>
109109
</Member>
110110
<Member MemberName="AddNestedContents">
@@ -252,7 +252,7 @@
252252
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
253253
<altmember cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.IsReadOnly" />
254254
<altmember cref="Overload:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey" />
255-
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Byte}, System.Security.Cryptography.PbeParameters)" />
255+
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)" />
256256
</Docs>
257257
</Member>
258258
<Member MemberName="AddShroudedKey">
@@ -291,7 +291,7 @@
291291
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
292292
<altmember cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.IsReadOnly" />
293293
<altmember cref="Overload:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey" />
294-
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Byte}, System.Security.Cryptography.PbeParameters)" />
294+
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)" />
295295
</Docs>
296296
</Member>
297297
<Member MemberName="AddShroudedKey">
@@ -330,7 +330,7 @@
330330
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
331331
<altmember cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.IsReadOnly" />
332332
<altmember cref="Overload:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey" />
333-
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Char}, System.Security.Cryptography.PbeParameters)" />
333+
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)" />
334334
</Docs>
335335
</Member>
336336
<Member MemberName="AddShroudedKey">
@@ -368,7 +368,7 @@
368368
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
369369
<altmember cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.IsReadOnly" />
370370
<altmember cref="Overload:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey" />
371-
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Char}, System.Security.Cryptography.PbeParameters)" />
371+
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey(System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)" />
372372
</Docs>
373373
</Member>
374374
<Member MemberName="ConfidentialityMode">

xml/System.Security.Cryptography.Pkcs/Pkcs12SecretBag.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
<summary>Gets a memory value containing the BER-encoded contents of the bag.</summary>
7070
<value>A memory value containing the BER-encoded contents of the bag.</value>
7171
<remarks>To be added.</remarks>
72-
<altmember cref="M:System.Security.Cryptography.Pkcs.Pkcs12SecretBag.GetSecretType()" />
72+
<altmember cref="M:System.Security.Cryptography.Pkcs.Pkcs12SecretBag.GetSecretType" />
7373
</Docs>
7474
</Member>
7575
</Members>

xml/System.Security.Cryptography/ECDiffieHellman.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1437,14 +1437,14 @@ The algorithm-specific key import failed.</exception>
14371437
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="net-5.0;netcore-3.0;netcore-3.1;netstandard-2.1" />
14381438
</Parameters>
14391439
<Docs>
1440-
<param name="destination">The byte span to receive the ECPrivateKey data.</param>
1440+
<param name="destination">The byte span to receive the <see langword="ECPrivateKey" /> data.</param>
14411441
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
1442-
<summary>Attempts to export the current key in the ECPrivateKey format into a provided buffer.</summary>
1442+
<summary>Attempts to export the current key in the <see langword="ECPrivateKey" /> format into a provided buffer.</summary>
14431443
<returns>
14441444
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
14451445
<remarks>To be added.</remarks>
14461446
<exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be exported.</exception>
1447-
<altmember cref="M:System.Security.Cryptography.ECDiffieHellman.ExportECPrivateKey()" />
1447+
<altmember cref="M:System.Security.Cryptography.ECDiffieHellman.ExportECPrivateKey" />
14481448
</Docs>
14491449
</Member>
14501450
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">

xml/System.Security.Cryptography/ECDiffieHellmanOpenSsl.xml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,7 @@ If key is loaded via the <xref:System.Security.Cryptography.ECDiffieHellmanOpenS
127127
## Remarks
128128
129129
> [!IMPORTANT]
130-
> OpenSSL supports multiple library versions being loaded within the same process.
131-
> Before calling this constructor verify your pointer value came from the same version of OpenSSL that this class uses, see <xref:System.Security.Cryptography.SafeEvpPKeyHandle.OpenSslVersion> for more information.
130+
> OpenSSL supports multiple library versions being loaded within the same process. Before calling this constructor, verify your pointer value came from the same version of OpenSSL that this class uses. For more information, see <xref:System.Security.Cryptography.SafeEvpPKeyHandle.OpenSslVersion>.
132131
133132
]]></format>
134133
</remarks>
@@ -192,9 +191,7 @@ If key is loaded via the <xref:System.Security.Cryptography.ECDiffieHellmanOpenS
192191
193192
## Remarks
194193
> [!IMPORTANT]
195-
> OpenSSL supports multiple library versions being loaded within the same process.
196-
> Before calling this constructor, verify your pointer value came from the same version of OpenSSL that this class uses.
197-
> For more information, see <xref:System.Security.Cryptography.SafeEvpPKeyHandle.OpenSslVersion>.
194+
> OpenSSL supports multiple library versions being loaded within the same process. Before calling this constructor, verify your pointer value came from the same version of OpenSSL that this class uses. For more information, see <xref:System.Security.Cryptography.SafeEvpPKeyHandle.OpenSslVersion>.
198195
]]></format>
199196
</remarks>
200197
<exception cref="T:System.ArgumentException">
@@ -203,7 +200,7 @@ If key is loaded via the <xref:System.Security.Cryptography.ECDiffieHellmanOpenS
203200
<paramref name="pkeyHandle" /> is <see langword="null" />.</exception>
204201
<exception cref="T:System.Security.Cryptography.CryptographicException">
205202
<paramref name="pkeyHandle" /> does not represent a elliptic curve (EC) key.</exception>
206-
<seealso cref="P:System.Security.Cryptography.SafeEvpPKeyValue.OpenSslVersion" />
203+
<seealso cref="P:System.Security.Cryptography.SafeEvpPKeyHandle.OpenSslVersion" />
207204
</Docs>
208205
</Member>
209206
<Member MemberName="DeriveKeyFromHash">

xml/System.Security.Cryptography/ECDsa.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1609,7 +1609,7 @@ The algorithm-specific key import failed.
16091609
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
16101610
<remarks>To be added.</remarks>
16111611
<exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be exported.</exception>
1612-
<altmember cref="M:System.Security.Cryptography.ECDsa.ExportECPrivateKey()" />
1612+
<altmember cref="M:System.Security.Cryptography.ECDsa.ExportECPrivateKey" />
16131613
</Docs>
16141614
</Member>
16151615
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">

xml/System.Security.Cryptography/RSA.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -593,8 +593,8 @@ The encryption operation failed.</exception>
593593
<remarks>To be added.</remarks>
594594
<exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be exported.</exception>
595595
<altmember cref="Overload:System.Security.Cryptography.AsymmetricAlgorithm.ExportEncryptedPkcs8PrivateKey" />
596-
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportPkcs8PrivateKey()" />
597-
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPublicKey()" />
596+
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportPkcs8PrivateKey" />
597+
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPublicKey" />
598598
<altmember cref="Overload:System.Security.Cryptography.RSA.TryExportRSAPrivateKey" />
599599
</Docs>
600600
</Member>
@@ -624,8 +624,8 @@ The encryption operation failed.</exception>
624624
<summary>Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format.</summary>
625625
<returns>A byte array containing the PKCS#1 RSAPublicKey representation of this key.</returns>
626626
<remarks>To be added.</remarks>
627-
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportSubjectPublicKeyInfo()" />
628-
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPrivateKey()" />
627+
<altmember cref="M:System.Security.Cryptography.AsymmetricAlgorithm.ExportSubjectPublicKeyInfo" />
628+
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPrivateKey" />
629629
<altmember cref="Overload:System.Security.Cryptography.RSA.TryExportRSAPublicKey" />
630630
</Docs>
631631
</Member>
@@ -1976,7 +1976,7 @@ The encryption operation failed.</exception>
19761976
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
19771977
<remarks>To be added.</remarks>
19781978
<exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be exported.</exception>
1979-
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPrivateKey()" />
1979+
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPrivateKey" />
19801980
</Docs>
19811981
</Member>
19821982
<Member MemberName="TryExportRSAPublicKey">
@@ -2012,7 +2012,7 @@ The encryption operation failed.</exception>
20122012
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
20132013
<remarks>To be added.</remarks>
20142014
<exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be exported.</exception>
2015-
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPublicKey()" />
2015+
<altmember cref="M:System.Security.Cryptography.RSA.ExportRSAPublicKey" />
20162016
</Docs>
20172017
</Member>
20182018
<Member MemberName="TryExportSubjectPublicKeyInfo">

xml/System.Security.Cryptography/RandomNumberGenerator.xml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -423,9 +423,7 @@ To create a random number generator, call the @System.Security.Cryptography.Rand
423423
<format type="text/markdown"><![CDATA[
424424
425425
## Remarks
426-
The length of the byte array determines how many random bytes are produced.
427-
428-
426+
The length of the byte array determines how many random bytes are produced.
429427
430428
## Examples
431429
The following example creates a random sequence 100 bytes long and stores it in `random`.
@@ -437,7 +435,7 @@ To create a random number generator, call the @System.Security.Cryptography.Rand
437435
]]></format>
438436
</remarks>
439437
<related type="Article" href="/dotnet/standard/security/cryptographic-services">Cryptographic Services</related>
440-
<altmember cref="M:System.Security.Cryptography.RandomNumberGenerator.Fill(System.Span&lt;System.Byte&gt;)" />
438+
<altmember cref="M:System.Security.Cryptography.RandomNumberGenerator.Fill(System.Span{System.Byte})" />
441439
</Docs>
442440
</Member>
443441
<Member MemberName="GetBytes">
@@ -468,7 +466,7 @@ To create a random number generator, call the @System.Security.Cryptography.Rand
468466
<param name="data">The span to fill with cryptographically strong random bytes.</param>
469467
<summary>Fills a span with cryptographically strong random bytes.</summary>
470468
<remarks>To be added.</remarks>
471-
<altmember cref="M:System.Security.Cryptography.RandomNumberGenerator.Fill(System.Span&lt;System.Byte&gt;)" />
469+
<altmember cref="M:System.Security.Cryptography.RandomNumberGenerator.Fill(System.Span{System.Byte})" />
472470
</Docs>
473471
</Member>
474472
<Member MemberName="GetBytes">

xml/System.ServiceModel.Channels/TcpConnectionPoolSettings.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -220,9 +220,7 @@
220220
<format type="text/markdown"><![CDATA[
221221
222222
## Remarks
223-
This limits the number of connections that are cached for each unique remote endpoint. If this value is exceeded by having more active client connections, then the service may appear unresponsive to the client and this value should be adjusted to exceed the maximum number of expected connections that are cached for each unique remote endpoint.
224-
225-
This setting can also be set on the service side, in which case the value is used to set the <xref:System.ServiceModel.Channels.MaxPooledConnections%2A> on the <xref:System.ServiceModel.Channels.TcpChannelListener>.
223+
This limits the number of connections that are cached for each unique remote endpoint. If this value is exceeded by having more active client connections, then the service may appear unresponsive to the client and this value should be adjusted to exceed the maximum number of expected connections that are cached for each unique remote endpoint.
226224
227225
]]></format>
228226
</remarks>

xml/System.ServiceModel.Configuration/TcpConnectionPoolSettingsElement.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,7 @@
210210
## Remarks
211211
Connections in excess of the limit are queued until a space below the limit becomes available. This property limits the duration in which connections remain queued before an exception is thrown.
212212
213-
This property limits the number of simultaneous active connections from the client to a particular service endpoint. If this value is exceeded by having more active client connections, the service may appear unresponsive to the client. In this case, this value should be adjusted to exceed the maximum number of expected simultaneous client connections to a specific endpoint.
214-
215-
This setting can also be set on the service side, in which case the value is used to set the <xref:System.ServiceModel.Channels.MaxPooledConnections%2A> on the <xref:System.ServiceModel.Channels.TcpChannelListener>.
213+
This property limits the number of simultaneous active connections from the client to a particular service endpoint. If this value is exceeded by having more active client connections, the service may appear unresponsive to the client. In this case, this value should be adjusted to exceed the maximum number of expected simultaneous client connections to a specific endpoint.
216214
217215
]]></format>
218216
</remarks>

0 commit comments

Comments
 (0)