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

View File

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

View File

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

View File

@ -33,7 +33,7 @@ namespace Microsoft.AspNetCore.Diagnostics.Elm
/// <summary> /// <summary>
/// Adds a new <see cref="ActivityContext"/> to the store. /// Adds a new <see cref="ActivityContext"/> to the store.
/// </summary> /// </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) public void AddActivity(ActivityContext activity)
{ {
if (activity == null) if (activity == null)

View File

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

View File

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

View File

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

View File

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

View File

@ -285,6 +285,7 @@ namespace Microsoft.AspNetCore.Diagnostics.Views
/// <summary> /// <summary>
/// Writes the specified <paramref name="value"/> without HTML encoding to <see cref="Output"/>. /// Writes the specified <paramref name="value"/> without HTML encoding to <see cref="Output"/>.
/// </summary> /// </summary>
/// <param name="writer">The <see cref="TextWriter"/> instance to write to.</param>
/// <param name="value">The <see cref="string"/> to write.</param> /// <param name="value">The <see cref="string"/> to write.</param>
protected void WriteLiteralTo(TextWriter writer, string value) 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.", "description": "ASP.NET 5 Middleware for exception handling, exception display pages, and diagnostics information.",
"compilationOptions": { "compilationOptions": {
"warningsAsErrors": true, "warningsAsErrors": true,
"keyFile": "../../tools/Key.snk" "keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
}, },
"repository": { "repository": {
"type": "git", "type": "git",

View File

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