Merge branch 'master' into publish-13610

Author: cxwtool

docfx.json

@@ -44,7 +44,7 @@
       "ms.author": "dotnetcontent",
       "ms.date": "04/30/2018",
       "searchScope": [".NET"],
-      "uhfHeaderId": "MSDocsHeader-DotNet",
+      "uhfHeaderId": [],
       "apiPlatform": "dotnet",
       "ms.topic": "managed-reference",
       "ms.prod": "dotnet-api",

xml/Microsoft.Extensions.Hosting/HostEnvironmentEnvExtensions.xml

@@ -40,10 +40,13 @@
       </Parameters>
       <Docs>
         <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
-        <summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />.</summary>
+        <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>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsEnvironment">
@@ -69,10 +72,13 @@
       <Docs>
         <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
         <param name="environmentName">Environment name to validate against.</param>
-        <summary>Compares the current host environment name against the specified value.</summary>
+        <summary>Compares the current host environment name against the specified value. Library authors should avoid using this API, see remarks for details.</summary>
         <returns>
           <see langword="true" /> if the specified name is the same as the current environment; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          Environment names are generally specific to an application. Libraries designed for use in many different applications
+          should avoid coupling behavior to specific environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsProduction">
@@ -96,10 +102,13 @@
       </Parameters>
       <Docs>
         <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
-        <summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />.</summary>
+        <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>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsStaging">
@@ -123,10 +132,13 @@
       </Parameters>
       <Docs>
         <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" />.</param>
-        <summary>Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />.</summary>
+        <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>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
   </Members>

xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml

@@ -44,10 +44,13 @@
       </Parameters>
       <Docs>
         <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
-        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />.</summary>
+        <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>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsEnvironment">
@@ -75,10 +78,13 @@
       <Docs>
         <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
         <param name="environmentName">Environment name to validate against.</param>
-        <summary>Compares the current hosting environment name against the specified value.</summary>
+        <summary>Compares the current hosting environment name against the specified value. Library authors should avoid using this API, see remarks for details.</summary>
         <returns>
           <see langword="true" /> if the specified name is the same as the current environment; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          Environment names are generally specific to an application. Libraries designed for use in many different applications
+          should avoid coupling behavior to specific environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsProduction">
@@ -104,10 +110,13 @@
       </Parameters>
       <Docs>
         <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
-        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />.</summary>
+        <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>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsStaging">
@@ -133,10 +142,13 @@
       </Parameters>
       <Docs>
         <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
-        <summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />.</summary>
+        <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>
         <returns>
           <see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />; otherwise, <see langword="false" />.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
+          authors should avoid coupling specific behavior to these environment names.
+        </remarks>
       </Docs>
     </Member>
   </Members>

xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml

@@ -1,4 +1,4 @@
-<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
+<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
   <TypeSignature Language="C#" Value="public class CancellationChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CancellationChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
   <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CancellationChangeToken" />
@@ -83,8 +83,8 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <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>
+        <value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
         <remarks>To be added.</remarks>
         <inheritdoc />
       </Docs>
@@ -115,8 +115,8 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets a value that indicates if a change has occurred.</summary>
+        <value><see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
         <remarks>To be added.</remarks>
         <inheritdoc />
       </Docs>
@@ -151,10 +151,10 @@
         <Parameter Name="state" Type="System.Object" />
       </Parameters>
       <Docs>
-        <param name="callback">To be added.</param>
-        <param name="state">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
+        <param name="state">State to be passed into the callback.</param>
+        <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>
+        <returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc />
       </Docs>

xml/Microsoft.Extensions.Primitives/ChangeToken.xml

@@ -90,7 +90,7 @@
         <Parameter Name="state" Type="TState" />
       </Parameters>
       <Docs>
-        <typeparam name="TState">To be added.</typeparam>
+        <typeparam name="TState">The type of the state for the <paramref name="changeTokenConsumer" /> action.</typeparam>
         <param name="changeTokenProducer">Produces the change token.</param>
         <param name="changeTokenConsumer">Action called when the token changes.</param>
         <param name="state">state for the consumer.</param>

xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml

@@ -1,4 +1,4 @@
-<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
+<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
   <TypeSignature Language="C#" Value="public class CompositeChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CompositeChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
   <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />
@@ -77,8 +77,8 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <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>
+        <value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
         <remarks>To be added.</remarks>
         <inheritdoc />
       </Docs>
@@ -105,7 +105,7 @@
       </ReturnValue>
       <Docs>
         <summary>Returns the list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />.</summary>
-        <value>To be added.</value>
+        <value>The list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> instances which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -133,8 +133,8 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets a value that indicates if a change has occurred.</summary>
+        <value><see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
         <remarks>To be added.</remarks>
         <inheritdoc />
       </Docs>
@@ -167,10 +167,10 @@
         <Parameter Name="state" Type="System.Object" />
       </Parameters>
       <Docs>
-        <param name="callback">To be added.</param>
-        <param name="state">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
+        <param name="state">State to be passed into the callback.</param>
+        <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>
+        <returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc />
       </Docs>

xml/Microsoft.Extensions.Primitives/IChangeToken.xml

@@ -47,7 +47,7 @@
       <Docs>
         <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>
-        <value>To be added.</value>
+        <value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -75,7 +75,7 @@
       </ReturnValue>
       <Docs>
         <summary>Gets a value that indicates if a change has occurred.</summary>
-        <value>To be added.</value>
+        <value><see langword="true" /> if a change has occurred; <see langword="false" /> otherwise.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>