Skip to content

Commit 24cfe33

Browse files
BillWagnerBillWagner
authored
Merge pull request #4236 from dotnet/publish-13610
Merge master into live
2 parents c7fba4a + fa0570e commit 24cfe33

34 files changed

+427
-336
lines changed

‎docfx.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"ms.author": "dotnetcontent",
4545
"ms.date": "04/30/2018",
4646
"searchScope": [".NET"],
47-
"uhfHeaderId": "MSDocsHeader-DotNet",
47+
"uhfHeaderId": [],
4848
"apiPlatform": "dotnet",
4949
"ms.topic": "managed-reference",
5050
"ms.prod": "dotnet-api",

‎xml/Microsoft.Extensions.Hosting/HostEnvironmentEnvExtensions.xml‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,13 @@
4040
</Parameters>
4141
<Docs>
4242
<param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
43-
<summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />.</summary>
43+
<summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />. This API should not be used in libraries, see remarks for details.</summary>
4444
<returns>
4545
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />; otherwise, <see langword="false" />.</returns>
46-
<remarks>To be added.</remarks>
46+
<remarks>
47+
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
48+
authors should avoid coupling specific behavior to these environment names.
49+
</remarks>
4750
</Docs>
4851
</Member>
4952
<Member MemberName="IsEnvironment">
@@ -69,10 +72,13 @@
6972
<Docs>
7073
<param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
7174
<param name="environmentName">Environment name to validate against.</param>
72-
<summary>Compares the current host environment name against the specified value.</summary>
75+
<summary>Compares the current host environment name against the specified value. Library authors should avoid using this API, see remarks for details.</summary>
7376
<returns>
7477
<see langword="true" /> if the specified name is the same as the current environment; otherwise, <see langword="false" />.</returns>
75-
<remarks>To be added.</remarks>
78+
<remarks>
79+
Environment names are generally specific to an application. Libraries designed for use in many different applications
80+
should avoid coupling behavior to specific environment names.
81+
</remarks>
7682
</Docs>
7783
</Member>
7884
<Member MemberName="IsProduction">
@@ -96,10 +102,13 @@
96102
</Parameters>
97103
<Docs>
98104
<param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
99-
<summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />.</summary>
105+
<summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />. This API should not be used in libraries, see remarks for details.</summary>
100106
<returns>
101107
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />; otherwise, <see langword="false" />.</returns>
102-
<remarks>To be added.</remarks>
108+
<remarks>
109+
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
110+
authors should avoid coupling specific behavior to these environment names.
111+
</remarks>
103112
</Docs>
104113
</Member>
105114
<Member MemberName="IsStaging">
@@ -123,10 +132,13 @@
123132
</Parameters>
124133
<Docs>
125134
<param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
126-
<summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />.</summary>
135+
<summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />. This API should not be used in libraries, see remarks for details.</summary>
127136
<returns>
128137
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />; otherwise, <see langword="false" />.</returns>
129-
<remarks>To be added.</remarks>
138+
<remarks>
139+
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
140+
authors should avoid coupling specific behavior to these environment names.
141+
</remarks>
130142
</Docs>
131143
</Member>
132144
</Members>

‎xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,13 @@
4444
</Parameters>
4545
<Docs>
4646
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
47-
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />.</summary>
47+
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />. This API should not be used in libraries, see remarks for details.</summary>
4848
<returns>
4949
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />; otherwise, <see langword="false" />.</returns>
50-
<remarks>To be added.</remarks>
50+
<remarks>
51+
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
52+
authors should avoid coupling specific behavior to these environment names.
53+
</remarks>
5154
</Docs>
5255
</Member>
5356
<Member MemberName="IsEnvironment">
@@ -75,10 +78,13 @@
7578
<Docs>
7679
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
7780
<param name="environmentName">Environment name to validate against.</param>
78-
<summary>Compares the current hosting environment name against the specified value.</summary>
81+
<summary>Compares the current hosting environment name against the specified value. Library authors should avoid using this API, see remarks for details.</summary>
7982
<returns>
8083
<see langword="true" /> if the specified name is the same as the current environment; otherwise, <see langword="false" />.</returns>
81-
<remarks>To be added.</remarks>
84+
<remarks>
85+
Environment names are generally specific to an application. Libraries designed for use in many different applications
86+
should avoid coupling behavior to specific environment names.
87+
</remarks>
8288
</Docs>
8389
</Member>
8490
<Member MemberName="IsProduction">
@@ -104,10 +110,13 @@
104110
</Parameters>
105111
<Docs>
106112
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
107-
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />.</summary>
113+
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />. This API should not be used in libraries, see remarks for details.</summary>
108114
<returns>
109115
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />; otherwise, <see langword="false" />.</returns>
110-
<remarks>To be added.</remarks>
116+
<remarks>
117+
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
118+
authors should avoid coupling specific behavior to these environment names.
119+
</remarks>
111120
</Docs>
112121
</Member>
113122
<Member MemberName="IsStaging">
@@ -133,10 +142,13 @@
133142
</Parameters>
134143
<Docs>
135144
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
136-
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />.</summary>
145+
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />. This API should not be used in libraries, see remarks for details.</summary>
137146
<returns>
138147
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />; otherwise, <see langword="false" />.</returns>
139-
<remarks>To be added.</remarks>
148+
<remarks>
149+
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
150+
authors should avoid coupling specific behavior to these environment names.
151+
</remarks>
140152
</Docs>
141153
</Member>
142154
</Members>

‎xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
1+
<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
22
<TypeSignature Language="C#" Value="public class CancellationChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CancellationChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CancellationChangeToken" />
@@ -83,8 +83,8 @@
8383
<ReturnType>System.Boolean</ReturnType>
8484
</ReturnValue>
8585
<Docs>
86-
<summary>To be added.</summary>
87-
<value>To be added.</value>
86+
<summary>Indicates if this token will pro-actively raise callbacks. If <see langword="false" />, the token consumer must poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.</summary>
87+
<value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
8888
<remarks>To be added.</remarks>
8989
<inheritdoc />
9090
</Docs>
@@ -115,8 +115,8 @@
115115
<ReturnType>System.Boolean</ReturnType>
116116
</ReturnValue>
117117
<Docs>
118-
<summary>To be added.</summary>
119-
<value>To be added.</value>
118+
<summary>Gets a value that indicates if a change has occurred.</summary>
119+
<value><see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
120120
<remarks>To be added.</remarks>
121121
<inheritdoc />
122122
</Docs>
@@ -151,10 +151,10 @@
151151
<Parameter Name="state" Type="System.Object" />
152152
</Parameters>
153153
<Docs>
154-
<param name="callback">To be added.</param>
155-
<param name="state">To be added.</param>
156-
<summary>To be added.</summary>
157-
<returns>To be added.</returns>
154+
<param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
155+
<param name="state">State to be passed into the callback.</param>
156+
<summary>Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> must be set before the callback is invoked.</summary>
157+
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
158158
<remarks>To be added.</remarks>
159159
<inheritdoc />
160160
</Docs>

‎xml/Microsoft.Extensions.Primitives/ChangeToken.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
<Parameter Name="state" Type="TState" />
9191
</Parameters>
9292
<Docs>
93-
<typeparam name="TState">To be added.</typeparam>
93+
<typeparam name="TState">The type of the state for the <paramref name="changeTokenConsumer" /> action.</typeparam>
9494
<param name="changeTokenProducer">Produces the change token.</param>
9595
<param name="changeTokenConsumer">Action called when the token changes.</param>
9696
<param name="state">state for the consumer.</param>

‎xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
1+
<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
22
<TypeSignature Language="C#" Value="public class CompositeChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CompositeChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />
@@ -77,8 +77,8 @@
7777
<ReturnType>System.Boolean</ReturnType>
7878
</ReturnValue>
7979
<Docs>
80-
<summary>To be added.</summary>
81-
<value>To be added.</value>
80+
<summary>Indicates if this token will pro-actively raise callbacks. If <see langword="false" />, the token consumer must poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.</summary>
81+
<value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
8282
<remarks>To be added.</remarks>
8383
<inheritdoc />
8484
</Docs>
@@ -105,7 +105,7 @@
105105
</ReturnValue>
106106
<Docs>
107107
<summary>Returns the list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />.</summary>
108-
<value>To be added.</value>
108+
<value>The list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> instances which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />.</value>
109109
<remarks>To be added.</remarks>
110110
</Docs>
111111
</Member>
@@ -133,8 +133,8 @@
133133
<ReturnType>System.Boolean</ReturnType>
134134
</ReturnValue>
135135
<Docs>
136-
<summary>To be added.</summary>
137-
<value>To be added.</value>
136+
<summary>Gets a value that indicates if a change has occurred.</summary>
137+
<value><see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
138138
<remarks>To be added.</remarks>
139139
<inheritdoc />
140140
</Docs>
@@ -167,10 +167,10 @@
167167
<Parameter Name="state" Type="System.Object" />
168168
</Parameters>
169169
<Docs>
170-
<param name="callback">To be added.</param>
171-
<param name="state">To be added.</param>
172-
<summary>To be added.</summary>
173-
<returns>To be added.</returns>
170+
<param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
171+
<param name="state">State to be passed into the callback.</param>
172+
<summary>Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> must be set before the callback is invoked.</summary>
173+
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
174174
<remarks>To be added.</remarks>
175175
<inheritdoc />
176176
</Docs>

‎xml/Microsoft.Extensions.Primitives/IChangeToken.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<Docs>
4848
<summary>Indicates if this token will pro-actively raise callbacks. If <see langword="false" />, the token consumer must
4949
poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.</summary>
50-
<value>To be added.</value>
50+
<value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
5151
<remarks>To be added.</remarks>
5252
</Docs>
5353
</Member>
@@ -75,7 +75,7 @@
7575
</ReturnValue>
7676
<Docs>
7777
<summary>Gets a value that indicates if a change has occurred.</summary>
78-
<value>To be added.</value>
78+
<value><see langword="true" /> if a change has occurred; <see langword="false" /> otherwise.</value>
7979
<remarks>To be added.</remarks>
8080
</Docs>
8181
</Member>

0 commit comments

Comments
 (0)