From 3e8368ad6629c8ca5a6769dc8520a9980997ac1c Mon Sep 17 00:00:00 2001
From: Ajay Bhargav Baaskaran <ajbaaska@microsoft.com>
Date: Thu, 18 Feb 2016 12:54:33 -0800
Subject: [PATCH] Enabled xml doc generation

---
 NuGetPackageVerifier.json                          | 14 ++------------
 .../Extensions/HeaderDictionaryExtensions.cs       |  4 ++++
 .../project.json                                   |  4 +++-
 .../SendFileResponseExtensions.cs                  |  2 ++
 .../project.json                                   |  4 +++-
 .../project.json                                   |  4 +++-
 src/Microsoft.AspNetCore.Http/project.json         |  4 +++-
 src/Microsoft.AspNetCore.Owin/project.json         |  4 +++-
 .../FormReader.cs                                  |  3 +++
 .../MultipartReaderStream.cs                       |  5 +++--
 .../WebEncoders.cs                                 |  4 ++--
 src/Microsoft.AspNetCore.WebUtilities/project.json |  4 +++-
 src/Microsoft.Net.Http.Headers/project.json        |  4 +++-
 13 files changed, 37 insertions(+), 23 deletions(-)

diff --git a/NuGetPackageVerifier.json b/NuGetPackageVerifier.json
index 647f42bb4f..9b4aae6984 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.Http": { },
@@ -20,12 +15,7 @@
     },
     "Default": { // Rules 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.Http.Abstractions/Extensions/HeaderDictionaryExtensions.cs b/src/Microsoft.AspNetCore.Http.Abstractions/Extensions/HeaderDictionaryExtensions.cs
index 79da20b342..65484981e0 100644
--- a/src/Microsoft.AspNetCore.Http.Abstractions/Extensions/HeaderDictionaryExtensions.cs
+++ b/src/Microsoft.AspNetCore.Http.Abstractions/Extensions/HeaderDictionaryExtensions.cs
@@ -11,6 +11,7 @@ namespace Microsoft.AspNetCore.Http
         /// <summary>
         /// Add new values. Each item remains a separate array entry.
         /// </summary>
+        /// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
         /// <param name="key">The header name.</param>
         /// <param name="value">The header value.</param>
         public static void Append(this IHeaderDictionary headers, string key, StringValues value)
@@ -21,6 +22,7 @@ namespace Microsoft.AspNetCore.Http
         /// <summary>
         /// Quotes any values containing comas, and then coma joins all of the values with any existing values.
         /// </summary>
+        /// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
         /// <param name="key">The header name.</param>
         /// <param name="values">The header values.</param>
         public static void AppendCommaSeparatedValues(this IHeaderDictionary headers, string key, params string[] values)
@@ -32,6 +34,7 @@ namespace Microsoft.AspNetCore.Http
         /// Get the associated values from the collection separated into individual values.
         /// Quoted values will not be split, and the quotes will be removed.
         /// </summary>
+        /// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
         /// <param name="key">The header name.</param>
         /// <returns>the associated values from the collection separated into individual values, or StringValues.Empty if the key is not present.</returns>
         public static string[] GetCommaSeparatedValues(this IHeaderDictionary headers, string key)
@@ -42,6 +45,7 @@ namespace Microsoft.AspNetCore.Http
         /// <summary>
         /// Quotes any values containing comas, and then coma joins all of the values.
         /// </summary>
+        /// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
         /// <param name="key">The header name.</param>
         /// <param name="values">The header values.</param>
         public static void SetCommaSeparatedValues(this IHeaderDictionary headers, string key, params string[] values)
diff --git a/src/Microsoft.AspNetCore.Http.Abstractions/project.json b/src/Microsoft.AspNetCore.Http.Abstractions/project.json
index 1779b5ee28..20578bac5c 100644
--- a/src/Microsoft.AspNetCore.Http.Abstractions/project.json
+++ b/src/Microsoft.AspNetCore.Http.Abstractions/project.json
@@ -7,7 +7,9 @@
   },
   "compilationOptions": {
     "warningsAsErrors": true,
-    "keyFile": "../../tools/Key.snk"
+    "keyFile": "../../tools/Key.snk",
+    "nowarn": [ "CS1591" ],
+    "xmlDoc": true
   },
   "dependencies": {
     "Microsoft.AspNetCore.Http.Features": "1.0.0-*",
diff --git a/src/Microsoft.AspNetCore.Http.Extensions/SendFileResponseExtensions.cs b/src/Microsoft.AspNetCore.Http.Extensions/SendFileResponseExtensions.cs
index c747df187b..cbddfe97c9 100644
--- a/src/Microsoft.AspNetCore.Http.Extensions/SendFileResponseExtensions.cs
+++ b/src/Microsoft.AspNetCore.Http.Extensions/SendFileResponseExtensions.cs
@@ -21,6 +21,7 @@ namespace Microsoft.AspNetCore.Http
         /// </summary>
         /// <param name="response"></param>
         /// <param name="file">The file.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
         public static Task SendFileAsync(this HttpResponse response, IFileInfo file,
             CancellationToken cancellationToken = default(CancellationToken))
         {
@@ -80,6 +81,7 @@ namespace Microsoft.AspNetCore.Http
         /// </summary>
         /// <param name="response"></param>
         /// <param name="fileName">The full path to the file.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
         /// <returns></returns>
         public static Task SendFileAsync(this HttpResponse response, string fileName,
             CancellationToken cancellationToken = default(CancellationToken))
diff --git a/src/Microsoft.AspNetCore.Http.Extensions/project.json b/src/Microsoft.AspNetCore.Http.Extensions/project.json
index a641249366..7f9b1ab34a 100644
--- a/src/Microsoft.AspNetCore.Http.Extensions/project.json
+++ b/src/Microsoft.AspNetCore.Http.Extensions/project.json
@@ -7,7 +7,9 @@
   },
   "compilationOptions": {
     "warningsAsErrors": true,
-    "keyFile": "../../tools/Key.snk"
+    "keyFile": "../../tools/Key.snk",
+    "nowarn": [ "CS1591" ],
+    "xmlDoc": true
   },
   "dependencies": {
     "Microsoft.AspNetCore.Http.Abstractions": "1.0.0-*",
diff --git a/src/Microsoft.AspNetCore.Http.Features/project.json b/src/Microsoft.AspNetCore.Http.Features/project.json
index 1b4d02bfe0..93ba9e9d4f 100644
--- a/src/Microsoft.AspNetCore.Http.Features/project.json
+++ b/src/Microsoft.AspNetCore.Http.Features/project.json
@@ -7,7 +7,9 @@
   },
   "compilationOptions": {
     "warningsAsErrors": true,
-    "keyFile": "../../tools/Key.snk"
+    "keyFile": "../../tools/Key.snk",
+    "nowarn": [ "CS1591" ],
+    "xmlDoc": true
   },
   "dependencies": {
     "Microsoft.Extensions.Primitives": "1.0.0-*"
diff --git a/src/Microsoft.AspNetCore.Http/project.json b/src/Microsoft.AspNetCore.Http/project.json
index 728e38ebcc..c2bc71063e 100644
--- a/src/Microsoft.AspNetCore.Http/project.json
+++ b/src/Microsoft.AspNetCore.Http/project.json
@@ -8,7 +8,9 @@
   "compilationOptions": {
     "warningsAsErrors": true,
     "allowUnsafe": true,
-    "keyFile": "../../tools/Key.snk"
+    "keyFile": "../../tools/Key.snk",
+    "nowarn": [ "CS1591" ],
+    "xmlDoc": true
   },
   "dependencies": {
     "Microsoft.AspNetCore.Http.Abstractions": "1.0.0-*",
diff --git a/src/Microsoft.AspNetCore.Owin/project.json b/src/Microsoft.AspNetCore.Owin/project.json
index 4a02e2515c..eb09487075 100644
--- a/src/Microsoft.AspNetCore.Owin/project.json
+++ b/src/Microsoft.AspNetCore.Owin/project.json
@@ -7,7 +7,9 @@
   },
   "compilationOptions": {
     "warningsAsErrors": true,
-    "keyFile": "../../tools/Key.snk"
+    "keyFile": "../../tools/Key.snk",
+    "nowarn": [ "CS1591" ],
+    "xmlDoc": true
   },
   "dependencies": {
     "Microsoft.AspNetCore.Http": "1.0.0-*"
diff --git a/src/Microsoft.AspNetCore.WebUtilities/FormReader.cs b/src/Microsoft.AspNetCore.WebUtilities/FormReader.cs
index a78e56c7d3..ca378895ef 100644
--- a/src/Microsoft.AspNetCore.WebUtilities/FormReader.cs
+++ b/src/Microsoft.AspNetCore.WebUtilities/FormReader.cs
@@ -184,6 +184,7 @@ namespace Microsoft.AspNetCore.WebUtilities
         /// Parses an HTTP form body.
         /// </summary>
         /// <param name="stream">The HTTP form body to parse.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
         /// <returns>The collection containing the parsed HTTP form body.</returns>
         public static Task<Dictionary<string, StringValues>> ReadFormAsync(Stream stream, CancellationToken cancellationToken = new CancellationToken())
         {
@@ -194,6 +195,8 @@ namespace Microsoft.AspNetCore.WebUtilities
         /// Parses an HTTP form body.
         /// </summary>
         /// <param name="stream">The HTTP form body to parse.</param>
+        /// <param name="encoding">The character encoding to use.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
         /// <returns>The collection containing the parsed HTTP form body.</returns>
         public static async Task<Dictionary<string, StringValues>> ReadFormAsync(Stream stream, Encoding encoding, CancellationToken cancellationToken = new CancellationToken())
         {
diff --git a/src/Microsoft.AspNetCore.WebUtilities/MultipartReaderStream.cs b/src/Microsoft.AspNetCore.WebUtilities/MultipartReaderStream.cs
index 22836ee320..442c693eab 100644
--- a/src/Microsoft.AspNetCore.WebUtilities/MultipartReaderStream.cs
+++ b/src/Microsoft.AspNetCore.WebUtilities/MultipartReaderStream.cs
@@ -23,8 +23,9 @@ namespace Microsoft.AspNetCore.WebUtilities
         /// <summary>
         /// Creates a stream that reads until it reaches the given boundary pattern.
         /// </summary>
-        /// <param name="stream"></param>
-        /// <param name="boundary"></param>
+        /// <param name="stream">The <see cref="BufferedReadStream"/>.</param>
+        /// <param name="boundary">The boundary pattern to use.</param>
+        /// <param name="expectLeadingCrlf">Specifies whether a leading crlf should be expected.</param>
         public MultipartReaderStream(BufferedReadStream stream, string boundary, bool expectLeadingCrlf = true)
         {
             if (stream == null)
diff --git a/src/Microsoft.AspNetCore.WebUtilities/WebEncoders.cs b/src/Microsoft.AspNetCore.WebUtilities/WebEncoders.cs
index e317d924eb..50f2eefbbc 100644
--- a/src/Microsoft.AspNetCore.WebUtilities/WebEncoders.cs
+++ b/src/Microsoft.AspNetCore.WebUtilities/WebEncoders.cs
@@ -156,7 +156,7 @@ namespace Microsoft.AspNetCore.WebUtilities
 
         /// <summary>
         /// Gets the minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters
-        /// with the <see cref="Base64UrlDecode(char[], int, int)"/> method.
+        /// with the <see cref="Base64UrlDecode(string, int, char[], int, int)"/> method.
         /// </summary>
         /// <param name="count">The number of characters to decode.</param>
         /// <returns>
@@ -305,7 +305,7 @@ namespace Microsoft.AspNetCore.WebUtilities
 
         /// <summary>
         /// Get the minimum output <c>char[]</c> size required for encoding <paramref name="count"/>
-        /// <see cref="byte"/>s with the <see cref="Base64UrlEncode(byte[], int, int, char[], int)"/> method.
+        /// <see cref="byte"/>s with the <see cref="Base64UrlEncode(byte[], int, char[], int, int)"/> method.
         /// </summary>
         /// <param name="count">The number of characters to encode.</param>
         /// <returns>
diff --git a/src/Microsoft.AspNetCore.WebUtilities/project.json b/src/Microsoft.AspNetCore.WebUtilities/project.json
index 9ff39f4337..6056e9e234 100644
--- a/src/Microsoft.AspNetCore.WebUtilities/project.json
+++ b/src/Microsoft.AspNetCore.WebUtilities/project.json
@@ -7,7 +7,9 @@
   },
   "compilationOptions": {
     "warningsAsErrors": true,
-    "keyFile": "../../tools/Key.snk"
+    "keyFile": "../../tools/Key.snk",
+    "nowarn": [ "CS1591" ],
+    "xmlDoc": true
   },
   "dependencies": {
     "Microsoft.Extensions.Primitives": "1.0.0-*",
diff --git a/src/Microsoft.Net.Http.Headers/project.json b/src/Microsoft.Net.Http.Headers/project.json
index a191b60875..323ec644c0 100644
--- a/src/Microsoft.Net.Http.Headers/project.json
+++ b/src/Microsoft.Net.Http.Headers/project.json
@@ -7,7 +7,9 @@
   },
   "compilationOptions": {
     "warningsAsErrors": true,
-    "keyFile": "../../tools/Key.snk"
+    "keyFile": "../../tools/Key.snk",
+    "nowarn": [ "CS1591" ],
+    "xmlDoc": true
   },
   "dependencies": {},
   "frameworks": {