Enabled xml doc generation

This commit is contained in:
Ajay Bhargav Baaskaran 2016-02-18 12:12:10 -08:00
parent 6aa848dd93
commit 4fe825793b
12 changed files with 30 additions and 24 deletions

View File

@ -1,29 +1,20 @@
{
"adx": { // Packages written by the ADX team and that ship on NuGet.org
"rules": [
"AssemblyHasDocumentFileRule",
"AssemblyHasVersionAttributesRule",
"AssemblyHasServicingAttributeRule",
"AssemblyHasNeutralResourcesLanguageAttributeRule",
"SatellitePackageRule",
"StrictSemanticVersionValidationRule"
"AdxVerificationCompositeRule"
],
"packages": {
"Microsoft.AspNetCore.Hosting": { },
"Microsoft.AspNetCore.Hosting.Abstractions": { },
"Microsoft.AspNetCore.Hosting.Server.Abstractions": { },
"Microsoft.AspNetCore.Hosting.WindowsServices": { },
"Microsoft.AspNetCore.Server.Testing": { },
"Microsoft.AspNetCore.TestHost": { }
}
},
"Default": { // Rules to run for packages not listed in any other set.
"rules": [
"AssemblyHasDocumentFileRule",
"AssemblyHasVersionAttributesRule",
"AssemblyHasServicingAttributeRule",
"AssemblyHasNeutralResourcesLanguageAttributeRule",
"SatellitePackageRule",
"StrictSemanticVersionValidationRule"
"DefaultCompositeRule"
]
}
}

View File

@ -2,7 +2,9 @@
"version": "1.0.0-*",
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"description": "ASP.NET 5 Hosting abstractions.",
"repository": {

View File

@ -10,6 +10,7 @@ namespace Microsoft.AspNetCore.Hosting.Server
/// <summary>
/// Represents an HttpApplication.
/// </summary>
/// <typeparam name="TContext">The context associated with the HttpApplication.</typeparam>
public interface IHttpApplication<TContext>
{
/// <summary>

View File

@ -19,7 +19,8 @@ namespace Microsoft.AspNetCore.Hosting.Server
/// <summary>
/// Start the server with an HttpApplication.
/// </summary>
/// <param name="application">An instance of <see cref="IHttpApplication"/>.</param>
/// <param name="application">An instance of <see cref="IHttpApplication{TContext}"/>.</param>
/// <typeparam name="TContext">The context associated with the HttpApplication.</typeparam>
void Start<TContext>(IHttpApplication<TContext> application);
}
}

View File

@ -2,7 +2,9 @@
"version": "1.0.0-*",
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"description": "ASP.NET 5 Hosting server abstractions.",
"repository": {

View File

@ -6,7 +6,7 @@ using System.ServiceProcess;
namespace Microsoft.AspNetCore.Hosting.WindowsServices
{
/// <summary>
/// Extensions to <see cref="IWebHost" for hosting inside a Windows service. />
/// Extensions to <see cref="IWebHost"/> for hosting inside a Windows service.
/// </summary>
public static class WebHostWindowsServiceExtensions
{
@ -15,7 +15,7 @@ namespace Microsoft.AspNetCore.Hosting.WindowsServices
/// </summary>
/// <param name="host">An instance of the <see cref="IWebHost"/> to host in the Windows service.</param>
/// <example>
/// This example shows how to use <see cref="WebHostService.Run"/>.
/// This example shows how to use <see cref="RunAsService"/>.
/// <code>
/// public class Program
/// {

View File

@ -7,7 +7,9 @@
},
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"dependencies": {
"Microsoft.AspNetCore.Hosting": "1.0.0-*"

View File

@ -47,7 +47,7 @@ namespace Microsoft.AspNetCore.Hosting
}
/// <summary>
/// Add or replace a setting in <see cref="Settings"/>.
/// Add or replace a setting in the configuration.
/// </summary>
/// <param name="key">The key of the setting to add or replace.</param>
/// <param name="value">The value of the setting to add or replace.</param>
@ -114,7 +114,7 @@ namespace Microsoft.AspNetCore.Hosting
/// <summary>
/// Specify the startup method to be used to configure the web application.
/// </summary>
/// <param name="configureApplication">The delegate that configures the <see cref="IApplicationBuilder"/>.</param>
/// <param name="configureApp">The delegate that configures the <see cref="IApplicationBuilder"/>.</param>
/// <returns>The <see cref="IWebHostBuilder"/>.</returns>
public IWebHostBuilder Configure(Action<IApplicationBuilder> configureApp)
{

View File

@ -7,7 +7,9 @@
},
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"dependencies": {
"Microsoft.AspNetCore.Hosting.Abstractions": "1.0.0-*",

View File

@ -2,7 +2,9 @@
"version": "1.0.0-*",
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"description": "ASP.NET 5 helpers to deploy applications to IIS Express, IIS, WebListener and Kestrel for testing.",
"repository": {

View File

@ -29,7 +29,8 @@ namespace Microsoft.AspNetCore.TestHost
/// <summary>
/// Create a new handler.
/// </summary>
/// <param name="next">The pipeline entry point.</param>
/// <param name="pathBase">The base path.</param>
/// <param name="application">The <see cref="IHttpApplication{TContext}"/>.</param>
public ClientHandler(PathString pathBase, IHttpApplication<Context> application)
{
if (application == null)

View File

@ -2,7 +2,9 @@
"version": "1.0.0-*",
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"description": "ASP.NET 5 web server for writing and running tests.",
"repository": {