Skip to content

Commit e4298df

Browse files
nxtnRon Petrusha
authored andcommitted
Add xref links (#11394)
* Add xref links * Add xref links * Add xref links * Add xref links * Add xref links * Apply suggestions from code review Co-Authored-By: NextTurn <45985406+NextTurn@users.noreply.github.com> * Apply suggestions from code review Co-Authored-By: NextTurn <45985406+NextTurn@users.noreply.github.com> * Apply suggestions from code review
1 parent 0ff4ac6 commit e4298df

File tree

44 files changed

+83
-81
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+83
-81
lines changed

docs/csharp/language-reference/compiler-options/refonly-compiler-option.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Reference assemblies include an assembly-level `ReferenceAssembly` attribute. Th
2828
Reference assemblies further remove metadata (private members) from metadata-only assemblies:
2929

3030
- A reference assembly only has references for what it needs in the API surface. The real assembly may have additional references related to specific implementations. For instance, the reference assembly for `class C { private void M() { dynamic d = 1; ... } }` does not reference any types required for `dynamic`.
31-
- Private function-members (methods, properties, and events) are removed in cases where their removal doesn't observably impact compilation. If there are no `InternalsVisibleTo` attributes, do the same for internal function-members.
31+
- Private function-members (methods, properties, and events) are removed in cases where their removal doesn't observably impact compilation. If there are no <xref:System.Runtime.CompilerServices.InternalsVisibleToAttribute> attributes, do the same for internal function-members.
3232
- But all types (including private or nested types) are kept in reference assemblies. All attributes are kept (even internal ones).
3333
- All virtual methods are kept. Explicit interface implementations are kept. Explicitly implemented properties and events are kept, as their accessors are virtual (and are therefore kept).
3434
- All fields of a struct are kept. (This is a candidate for post-C#-7.1 refinement)

docs/csharp/language-reference/compiler-options/refout-compiler-option.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Reference assemblies include an assembly-level `ReferenceAssembly` attribute. Th
3333
Reference assemblies further remove metadata (private members) from metadata-only assemblies:
3434

3535
- A reference assembly only has references for what it needs in the API surface. The real assembly may have additional references related to specific implementations. For instance, the reference assembly for `class C { private void M() { dynamic d = 1; ... } }` does not reference any types required for `dynamic`.
36-
- Private function-members (methods, properties, and events) are removed in cases where their removal doesn't observably impact compilation. If there are no `InternalsVisibleTo` attributes, do the same for internal function-members.
36+
- Private function-members (methods, properties, and events) are removed in cases where their removal doesn't observably impact compilation. If there are no <xref:System.Runtime.CompilerServices.InternalsVisibleToAttribute> attributes, do the same for internal function-members.
3737
- But all types (including private or nested types) are kept in reference assemblies. All attributes are kept (even internal ones).
3838
- All virtual methods are kept. Explicit interface implementations are kept. Explicitly implemented properties and events are kept, as their accessors are virtual (and are therefore kept).
3939
- All fields of a struct are kept. (This is a candidate for post-C#-7.1 refinement)

docs/csharp/tutorials/console-webapiclient.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -290,11 +290,11 @@ Compile and run the application. It will print out the names of the repositories
290290
Before you add more features, let's address the `repo` type and make it follow more standard
291291
C# conventions. You'll do this by annotating the `repo` type with *attributes* that control how
292292
the JSON Serializer works. In your case, you'll use these attributes to define a mapping between
293-
the JSON key names and the C# class and member names. The two attributes used are the `DataContract`
294-
attribute and the `DataMember` attribute. By convention, all Attribute classes end in the suffix
293+
the JSON key names and the C# class and member names. The two attributes used are the <xref:System.Runtime.Serialization.DataContractAttribute>
294+
and <xref:System.Runtime.Serialization.DataMemberAttribute> attributes. By convention, all Attribute classes end in the suffix
295295
`Attribute`. However, you do not need to use that suffix when you apply an attribute.
296296

297-
The `DataContract` and `DataMember` attributes are in a different library, so you'll need to add
297+
The <xref:System.Runtime.Serialization.DataContractAttribute> and <xref:System.Runtime.Serialization.DataMemberAttribute> attributes are in a different library, so you'll need to add
298298
that library to your C# project file as a dependency. Add the following line to the `<ItemGroup>` section of your project file:
299299

300300
```xml
@@ -305,7 +305,7 @@ After you save the file, run `dotnet restore` ([see note](#dotnet-restore-note))
305305

306306
Next, open the `repo.cs` file. Let's change the name to use Pascal Case, and fully spell out the name
307307
`Repository`. We still want to map JSON 'repo' nodes to this type, so you'll need to add the
308-
`DataContract` attribute to the class declaration. You'll set the `Name` property of the attribute
308+
<xref:System.Runtime.Serialization.DataContractAttribute> attribute to the class declaration. You'll set the `Name` property of the attribute
309309
to the name of the JSON nodes that map to this type:
310310

311311
```csharp
@@ -465,7 +465,7 @@ string representation of the date time in your `Repository` class:
465465
private string JsonDate { get; set; }
466466
```
467467

468-
The `DataMember` attribute informs the serializer that this should be processed, even though it is not
468+
The <xref:System.Runtime.Serialization.DataMemberAttribute> attribute informs the serializer that this should be processed, even though it is not
469469
a public member. Next, you need to write a public read-only property that converts the string to a
470470
valid <xref:System.DateTime> object, and returns that <xref:System.DateTime>:
471471

docs/framework/configure-apps/file-schema/wcf/basichttpbinding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Represents a binding that a Windows Communication Foundation (WCF) service can u
6060
|`bypassProxyOnLocal`|A Boolean value that indicates whether to bypass the proxy server for local addresses. The default is `false`.<br /><br /> An Internet resource is local if it has a local address. A local address is one that is on same computer, the local LAN or intranet and is identified, syntactically, by the lack of a period (.) as in the URIs "http://webserver/" and "http://localhost/".<br /><br /> Setting this attribute determines whether endpoints configured with the BasicHttpBinding use the proxy server when accessing local resources. If this attribute is `true`, requests to local Internet resources do not use the proxy server. Use the host name (rather than localhost) if you want clients to go through a proxy when talking to services on the same machine when this attribute is set to `true`.<br /><br /> When this attribute is `false`, all Internet requests are made through the proxy server.|
6161
|`closeTimeout`|A <xref:System.TimeSpan> value that specifies the interval of time provided for a close operation to complete. This value should be greater than or equal to <xref:System.TimeSpan.Zero>. The default is 00:01:00.|
6262
|`envelopeVersion`|Specifies the version of SOAP that is used for messages that are processed by this binding. The only valid value is Soap11.|
63-
|`hostnameComparisonMode`|Specifies the HTTP hostname comparison mode used to parse URIs. This attribute is of type <xref:System.ServiceModel.HostNameComparisonMode>, which indicates whether the hostname is used to reach the service when matching on the URI. The default value is <xref:System.ServiceModel.HostNameComparisonMode.StrongWildcard>, which ignores the hostname in the match.|
63+
|`hostNameComparisonMode`|Specifies the HTTP hostname comparison mode used to parse URIs. This attribute is of type <xref:System.ServiceModel.HostNameComparisonMode>, which indicates whether the hostname is used to reach the service when matching on the URI. The default value is <xref:System.ServiceModel.HostNameComparisonMode.StrongWildcard>, which ignores the hostname in the match.|
6464
|`maxBufferPoolSize`|An integer value that specifies the maximum amount of memory that is allocated for use by the manager of the message buffers that receive messages from the channel. The default value is 524288 (0x80000) bytes.<br /><br /> The Buffer Manager minimizes the cost of using buffers by using a buffer pool. Buffers are required to process messages by the service when they come out of the channel. If there is not sufficient memory in the buffer pool to process the message load, the Buffer Manager must allocate additional memory from the CLR heap, which increases the garbage collection overhead. Extensive allocation from the CLR garbage heap is an indication that the buffer pool size is too small and that performance can be improved with a larger allocation by increasing the limit specified by this attribute.|
6565
|`maxBufferSize`|An integer value that specifies the maximum size, in bytes, of a buffer that stores messages while they are processed for an endpoint configured with this binding. The default value is 65,536 bytes.|
6666
|`maxReceivedMessageSize`|A positive integer that defines the maximum message size, in bytes, including headers, for a message that can be received on a channel configured with this binding. The sender receives a SOAP fault if the message is too large for the receiver. The receiver drops the message and creates an entry of the event in the trace log. The default is 65,536 bytes.|

docs/framework/configure-apps/file-schema/wcf/basichttpcontextbinding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Specifying a binding that provides context for the <xref:System.ServiceModel.Bas
5858
|`bypassProxyOnLocal`|A Boolean value that indicates whether to bypass the proxy server for local addresses. The default is `false`.<br /><br /> An Internet resource is local if it has a local address. A local address is one that is on same computer, the local LAN or intranet and is identified, syntactically, by the lack of a period (.) as in the URIs "http://webserver/" and "http://localhost/".<br /><br /> Setting this attribute determines whether endpoints configured with the BasicHttpBinding use the proxy server when accessing local resources. If this attribute is `true`, requests to local Internet resources do not use the proxy server. Use the host name (rather than localhost) if you want clients to go through a proxy when talking to services on the same machine when this attribute is set to `true`.<br /><br /> When this attribute is `false`, all Internet requests are made through the proxy server.|
5959
|`closeTimeout`|A <xref:System.TimeSpan> value that specifies the interval of time provided for a close operation to complete. This value should be greater than or equal to <xref:System.TimeSpan.Zero>. The default is 00:01:00.|
6060
|`envelopeVersion`|Specifies the version of SOAP that is used for messages that are processed by this binding. The only valid value is Soap11.|
61-
|`hostnameComparisonMode`|Specifies the HTTP hostname comparison mode used to parse URIs. This attribute is of type <xref:System.ServiceModel.HostNameComparisonMode>, which indicates whether the hostname is used to reach the service when matching on the URI. The default value is <xref:System.ServiceModel.HostNameComparisonMode.StrongWildcard>, which ignores the hostname in the match.|
61+
|`hostNameComparisonMode`|Specifies the HTTP hostname comparison mode used to parse URIs. This attribute is of type <xref:System.ServiceModel.HostNameComparisonMode>, which indicates whether the hostname is used to reach the service when matching on the URI. The default value is <xref:System.ServiceModel.HostNameComparisonMode.StrongWildcard>, which ignores the hostname in the match.|
6262
|`maxBufferPoolSize`|An integer value that specifies the maximum amount of memory that is allocated for use by the manager of the message buffers that receive messages from the channel. The default value is 524288 (0x80000) bytes.<br /><br /> The Buffer Manager minimizes the cost of using buffers by using a buffer pool. Buffers are required to process messages by the service when they come out of the channel. If there is not sufficient memory in the buffer pool to process the message load, the Buffer Manager must allocate additional memory from the CLR heap, which increases the garbage collection overhead. Extensive allocation from the CLR garbage heap is an indication that the buffer pool size is too small and that performance can be improved with a larger allocation by increasing the limit specified by this attribute.|
6363
|`maxBufferSize`|An integer value that specifies the maximum size, in bytes, of a buffer that stores messages while they are processed for an endpoint configured with this binding. The default value is 65,536 bytes.|
6464
|`maxReceivedMessageSize`|A positive integer that defines the maximum message size, in bytes, including headers, for a message that can be received on a channel configured with this binding. The sender receives a SOAP fault if the message is too large for the receiver. The receiver drops the message and creates an entry of the event in the trace log. The default is 65,536 bytes.|

docs/framework/configure-apps/file-schema/wcf/httpstransport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Specifies an HTTP transport for transmitting SOAP messages for a custom binding.
4848
|maxBufferSize|A positive integer that specifies the maximum size of the buffer. The default is 524288|
4949
|maxReceivedMessageSize|A positive integer that specifies the maximum allowable message size that can be received. The default is 65536.|
5050
|proxyAddress|A URI that specifies the address of the HTTP proxy. If `useSystemWebProxy` is `true`, this setting must be `null`. The default is `null`.|
51-
|proxyAuthenticationScheme|Specifies the protocol used for authenticating client requests being processed by an HTTP proxy. Valid values include the following:<br /><br /> - None: No authentication is performed.<br />- Digest: Specifies digest authentication.<br />- Negotiate: Negotiates with the client to determine the authentication scheme. If both client and server support Kerberos, it is used; otherwise, NTLM is used.<br />- Ntlm: Specifies NTLM authentication.<br />- Basic: Specifies basic authentication.<br />- Anonymous: Specifies anonymous authentication.<br /><br /> The default is Anonymous. This attribute is of type <xref:System.Net.AuthenticationSchemes>. Note that `IntegratedWindowsAuthentication` is not supported.|
51+
|proxyAuthenticationScheme|Specifies the protocol used for authenticating client requests being processed by an HTTP proxy. Valid values include the following:<br /><br /> - None: No authentication is performed.<br />- Digest: Specifies digest authentication.<br />- Negotiate: Negotiates with the client to determine the authentication scheme. If both client and server support Kerberos, it is used; otherwise, NTLM is used.<br />- Ntlm: Specifies NTLM authentication.<br />- Basic: Specifies basic authentication.<br />- Anonymous: Specifies anonymous authentication.<br /><br /> The default is Anonymous. This attribute is of type <xref:System.Net.AuthenticationSchemes>. Note that <xref:System.Net.AuthenticationSchemes.IntegratedWindowsAuthentication?displayProperty=nameWithType> is not supported.|
5252
|realm|A string that specifies the realm to use on the proxy/server. The default is an empty string.<br /><br /> Servers use realms to partition protected resources. Each partition can have its own authentication scheme and/or authorization database. Realms are used only for basic and digest authentication. After a client successfully authenticates, the authentication is valid for all resources in a given realm. For a detailed description of realms, see RFC 2617 at the [IETF website](https://www.ietf.org).|
5353
|requireClientCertificate|A Boolean value that specifies if the server requires the client to provide a client certificate as part of the HTTPS handshake. The default is `false`.|
5454
|transferMode|Specifies whether messages are buffered or streamed or a request or response. Valid values include the following:<br /><br /> - Buffered: The request and response messages are buffered.<br />- Streamed: The request and response messages are streamed.<br />- StreamedRequest: The request message is streamed and the response message is buffered.<br />- StreamedResponse: The request message is buffered and the response message is streamed.<br /><br /> The default is Buffered. This attribute is of type <xref:System.ServiceModel.TransferMode>.|

0 commit comments

Comments
 (0)