From b5ff692dbfde2c477afd970b7871313536510f17 Mon Sep 17 00:00:00 2001 From: Ajay Bhargav Baaskaran Date: Fri, 19 Feb 2016 12:25:51 -0800 Subject: [PATCH] Enabled xml doc generation --- NuGetPackageVerifier.json | 14 ++------------ .../project.json | 4 +++- src/Microsoft.Net.Http.Server/Helpers.cs | 1 - .../NativeInterop/AddressFamily.cs | 10 +++++++++- src/Microsoft.Net.Http.Server/UrlPrefix.cs | 2 +- src/Microsoft.Net.Http.Server/project.json | 4 +++- src/Microsoft.Net.WebSockets.Server/project.json | 4 +++- 7 files changed, 21 insertions(+), 18 deletions(-) diff --git a/NuGetPackageVerifier.json b/NuGetPackageVerifier.json index e087c17fa1..d13c12ca63 100644 --- a/NuGetPackageVerifier.json +++ b/NuGetPackageVerifier.json @@ -1,12 +1,7 @@ { "adx": { // Packages written by the ADX team and that ship on NuGet.org "rules": [ - "AssemblyHasDocumentFileRule", - "AssemblyHasVersionAttributesRule", - "AssemblyHasServicingAttributeRule", - "AssemblyHasNeutralResourcesLanguageAttributeRule", - "SatellitePackageRule", - "StrictSemanticVersionValidationRule" + "AdxVerificationCompositeRule" ], "packages": { "Microsoft.AspNetCore.Server.WebListener": { }, @@ -16,12 +11,7 @@ }, "Default": { // Ru les to run for packages not listed in any other set. "rules": [ - "AssemblyHasDocumentFileRule", - "AssemblyHasVersionAttributesRule", - "AssemblyHasServicingAttributeRule", - "AssemblyHasNeutralResourcesLanguageAttributeRule", - "SatellitePackageRule", - "StrictSemanticVersionValidationRule" + "DefaultCompositeRule" ] } } \ No newline at end of file diff --git a/src/Microsoft.AspNetCore.Server.WebListener/project.json b/src/Microsoft.AspNetCore.Server.WebListener/project.json index 4fedde9e11..3c73aa60b2 100644 --- a/src/Microsoft.AspNetCore.Server.WebListener/project.json +++ b/src/Microsoft.AspNetCore.Server.WebListener/project.json @@ -9,7 +9,9 @@ "compilationOptions": { "allowUnsafe": true, "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "frameworks": { "net451": {}, diff --git a/src/Microsoft.Net.Http.Server/Helpers.cs b/src/Microsoft.Net.Http.Server/Helpers.cs index 428edffa1d..a117fe2490 100644 --- a/src/Microsoft.Net.Http.Server/Helpers.cs +++ b/src/Microsoft.Net.Http.Server/Helpers.cs @@ -88,7 +88,6 @@ namespace Microsoft.Net.Http.Server /// Generates a right-aligned hex string and returns the start offset. /// /// Chunk size to be encoded - /// Out parameter where we store offset into buffer. /// A byte array with the header in int. internal static ArraySegment GetChunkHeader(int size) { diff --git a/src/Microsoft.Net.Http.Server/NativeInterop/AddressFamily.cs b/src/Microsoft.Net.Http.Server/NativeInterop/AddressFamily.cs index c1c6def0cf..cc7f44b913 100644 --- a/src/Microsoft.Net.Http.Server/NativeInterop/AddressFamily.cs +++ b/src/Microsoft.Net.Http.Server/NativeInterop/AddressFamily.cs @@ -23,12 +23,20 @@ namespace Microsoft.Net.Http.Server { +#if NET451 /// /// - /// Specifies the address families that an instance of the + /// Specifies the address families that an instance of the /// class can use. /// /// +#else + /// + /// + /// Specifies the address families. + /// + /// +#endif internal enum AddressFamily { /// diff --git a/src/Microsoft.Net.Http.Server/UrlPrefix.cs b/src/Microsoft.Net.Http.Server/UrlPrefix.cs index 34689b9eac..8e72903252 100644 --- a/src/Microsoft.Net.Http.Server/UrlPrefix.cs +++ b/src/Microsoft.Net.Http.Server/UrlPrefix.cs @@ -62,7 +62,7 @@ namespace Microsoft.Net.Http.Server /// /// http or https. Will be normalized to lower case. /// +, *, IPv4, [IPv6], or a dns name. Http.Sys does not permit punycode (xn--), use Unicode instead. - /// If empty, the default port for the given scheme will be used (80 or 443). + /// If empty, the default port for the given scheme will be used (80 or 443). /// Should start and end with a '/', though a missing trailing slash will be added. This value must be un-escaped. public static UrlPrefix Create(string scheme, string host, int? portValue, string path) { diff --git a/src/Microsoft.Net.Http.Server/project.json b/src/Microsoft.Net.Http.Server/project.json index 66c1776780..5b5861dd58 100644 --- a/src/Microsoft.Net.Http.Server/project.json +++ b/src/Microsoft.Net.Http.Server/project.json @@ -8,7 +8,9 @@ "compilationOptions": { "allowUnsafe": true, "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "frameworks": { "net451": {}, diff --git a/src/Microsoft.Net.WebSockets.Server/project.json b/src/Microsoft.Net.WebSockets.Server/project.json index 4950a5428b..7d83e64239 100644 --- a/src/Microsoft.Net.WebSockets.Server/project.json +++ b/src/Microsoft.Net.WebSockets.Server/project.json @@ -7,7 +7,9 @@ "compilationOptions": { "allowUnsafe": true, "warningsAsErrors": true, - "keyFile": "../../tools/Key.snk" + "keyFile": "../../tools/Key.snk", + "nowarn": [ "CS1591" ], + "xmlDoc": true }, "frameworks": { "net451": {},