Enabled xml doc generation

This commit is contained in:
Ajay Bhargav Baaskaran 2016-02-17 16:57:39 -08:00
parent a03b2dc6b4
commit 8bde9b7e72
11 changed files with 26 additions and 20 deletions

View File

@ -1,18 +1,14 @@
{
"adx": { // Packages written by the ADX team and that ship on NuGet.org
"rules": [
"AssemblyHasDocumentFileRule",
"AssemblyHasVersionAttributesRule",
"AssemblyHasServicingAttributeRule",
"AssemblyHasNeutralResourcesLanguageAttributeRule",
"SatellitePackageRule",
"StrictSemanticVersionValidationRule"
"AdxVerificationCompositeRule"
],
"packages": {
"Microsoft.AspNetCore.Diagnostics": { },
"Microsoft.AspNetCore.Diagnostics.Abstractions": { },
"Microsoft.AspNetCore.Diagnostics.Elm": { },
"Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore": { }
"Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore": { },
"Microsoft.AspNetCore.MiddlewareAnalysis": { }
}
},
"adx-nonshipping": {
@ -23,12 +19,7 @@
},
"Default": { // Rules to run for packages not listed in any other set.
"rules": [
"AssemblyHasDocumentFileRule",
"AssemblyHasVersionAttributesRule",
"AssemblyHasServicingAttributeRule",
"AssemblyHasNeutralResourcesLanguageAttributeRule",
"SatellitePackageRule",
"StrictSemanticVersionValidationRule"
"DefaultCompositeRule"
]
}
}

View File

@ -7,7 +7,9 @@
},
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"frameworks": {
"net451": {},

View File

@ -19,7 +19,7 @@ namespace Microsoft.AspNetCore.Diagnostics.Elm
/// <summary>
/// Determines whether log statements should be logged based on the name of the logger
/// and the <see cref="LogLevel"/> of the message.
/// and the <see cref="M:LogLevel"/> of the message.
/// </summary>
public Func<string, LogLevel, bool> Filter { get; set; } = (name, level) => true;
}

View File

@ -33,7 +33,7 @@ namespace Microsoft.AspNetCore.Diagnostics.Elm
/// <summary>
/// Adds a new <see cref="ActivityContext"/> to the store.
/// </summary>
/// <param name="context">The context to be added to the store.</param>
/// <param name="activity">The <see cref="ActivityContext"/> to be added to the store.</param>
public void AddActivity(ActivityContext activity)
{
if (activity == null)

View File

@ -3,7 +3,9 @@
"description": "ASP.NET 5 Middleware to capture and display the request logs.",
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"repository": {
"type": "git",

View File

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

View File

@ -37,6 +37,9 @@ namespace Microsoft.AspNetCore.Diagnostics
/// </summary>
/// <param name="next"></param>
/// <param name="options"></param>
/// <param name="loggerFactory"></param>
/// <param name="appEnvironment"></param>
/// <param name="diagnosticSource"></param>
public DeveloperExceptionPageMiddleware(
RequestDelegate next,
IOptions<DeveloperExceptionPageOptions> options,

View File

@ -25,6 +25,7 @@ namespace Microsoft.AspNetCore.Diagnostics
/// </summary>
/// <param name="next"></param>
/// <param name="options"></param>
/// <param name="runtimeEnvironment"></param>
public RuntimeInfoMiddleware(
RequestDelegate next,
IOptions<RuntimeInfoPageOptions> options,

View File

@ -285,6 +285,7 @@ namespace Microsoft.AspNetCore.Diagnostics.Views
/// <summary>
/// Writes the specified <paramref name="value"/> without HTML encoding to <see cref="Output"/>.
/// </summary>
/// <param name="writer">The <see cref="TextWriter"/> instance to write to.</param>
/// <param name="value">The <see cref="string"/> to write.</param>
protected void WriteLiteralTo(TextWriter writer, string value)
{

View File

@ -3,7 +3,9 @@
"description": "ASP.NET 5 Middleware for exception handling, exception display pages, and diagnostics information.",
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"repository": {
"type": "git",

View File

@ -3,7 +3,9 @@
"description": "ASP.NET 5 Middleware for analyzing middleware in the request pipeline.",
"compilationOptions": {
"warningsAsErrors": true,
"keyFile": "../../tools/Key.snk"
"keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
},
"repository": {
"type": "git",