Enabled xml doc generation
This commit is contained in:
parent
d4e72564c7
commit
3e8368ad66
|
|
@ -1,12 +1,7 @@
|
||||||
{
|
{
|
||||||
"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.Http": { },
|
"Microsoft.AspNetCore.Http": { },
|
||||||
|
|
@ -20,12 +15,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"
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -11,6 +11,7 @@ namespace Microsoft.AspNetCore.Http
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Add new values. Each item remains a separate array entry.
|
/// Add new values. Each item remains a separate array entry.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
|
||||||
/// <param name="key">The header name.</param>
|
/// <param name="key">The header name.</param>
|
||||||
/// <param name="value">The header value.</param>
|
/// <param name="value">The header value.</param>
|
||||||
public static void Append(this IHeaderDictionary headers, string key, StringValues value)
|
public static void Append(this IHeaderDictionary headers, string key, StringValues value)
|
||||||
|
|
@ -21,6 +22,7 @@ namespace Microsoft.AspNetCore.Http
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Quotes any values containing comas, and then coma joins all of the values with any existing values.
|
/// Quotes any values containing comas, and then coma joins all of the values with any existing values.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
|
||||||
/// <param name="key">The header name.</param>
|
/// <param name="key">The header name.</param>
|
||||||
/// <param name="values">The header values.</param>
|
/// <param name="values">The header values.</param>
|
||||||
public static void AppendCommaSeparatedValues(this IHeaderDictionary headers, string key, params string[] values)
|
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.
|
/// Get the associated values from the collection separated into individual values.
|
||||||
/// Quoted values will not be split, and the quotes will be removed.
|
/// Quoted values will not be split, and the quotes will be removed.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
|
||||||
/// <param name="key">The header name.</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>
|
/// <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)
|
public static string[] GetCommaSeparatedValues(this IHeaderDictionary headers, string key)
|
||||||
|
|
@ -42,6 +45,7 @@ namespace Microsoft.AspNetCore.Http
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Quotes any values containing comas, and then coma joins all of the values.
|
/// Quotes any values containing comas, and then coma joins all of the values.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <param name="headers">The <see cref="IHeaderDictionary"/> to use.</param>
|
||||||
/// <param name="key">The header name.</param>
|
/// <param name="key">The header name.</param>
|
||||||
/// <param name="values">The header values.</param>
|
/// <param name="values">The header values.</param>
|
||||||
public static void SetCommaSeparatedValues(this IHeaderDictionary headers, string key, params string[] values)
|
public static void SetCommaSeparatedValues(this IHeaderDictionary headers, string key, params string[] values)
|
||||||
|
|
|
||||||
|
|
@ -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.Http.Features": "1.0.0-*",
|
"Microsoft.AspNetCore.Http.Features": "1.0.0-*",
|
||||||
|
|
|
||||||
|
|
@ -21,6 +21,7 @@ namespace Microsoft.AspNetCore.Http
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="response"></param>
|
/// <param name="response"></param>
|
||||||
/// <param name="file">The file.</param>
|
/// <param name="file">The file.</param>
|
||||||
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
|
||||||
public static Task SendFileAsync(this HttpResponse response, IFileInfo file,
|
public static Task SendFileAsync(this HttpResponse response, IFileInfo file,
|
||||||
CancellationToken cancellationToken = default(CancellationToken))
|
CancellationToken cancellationToken = default(CancellationToken))
|
||||||
{
|
{
|
||||||
|
|
@ -80,6 +81,7 @@ namespace Microsoft.AspNetCore.Http
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="response"></param>
|
/// <param name="response"></param>
|
||||||
/// <param name="fileName">The full path to the file.</param>
|
/// <param name="fileName">The full path to the file.</param>
|
||||||
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
public static Task SendFileAsync(this HttpResponse response, string fileName,
|
public static Task SendFileAsync(this HttpResponse response, string fileName,
|
||||||
CancellationToken cancellationToken = default(CancellationToken))
|
CancellationToken cancellationToken = default(CancellationToken))
|
||||||
|
|
|
||||||
|
|
@ -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.Http.Abstractions": "1.0.0-*",
|
"Microsoft.AspNetCore.Http.Abstractions": "1.0.0-*",
|
||||||
|
|
|
||||||
|
|
@ -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.Extensions.Primitives": "1.0.0-*"
|
"Microsoft.Extensions.Primitives": "1.0.0-*"
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,9 @@
|
||||||
"compilationOptions": {
|
"compilationOptions": {
|
||||||
"warningsAsErrors": true,
|
"warningsAsErrors": true,
|
||||||
"allowUnsafe": true,
|
"allowUnsafe": true,
|
||||||
"keyFile": "../../tools/Key.snk"
|
"keyFile": "../../tools/Key.snk",
|
||||||
|
"nowarn": [ "CS1591" ],
|
||||||
|
"xmlDoc": true
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"Microsoft.AspNetCore.Http.Abstractions": "1.0.0-*",
|
"Microsoft.AspNetCore.Http.Abstractions": "1.0.0-*",
|
||||||
|
|
|
||||||
|
|
@ -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.Http": "1.0.0-*"
|
"Microsoft.AspNetCore.Http": "1.0.0-*"
|
||||||
|
|
|
||||||
|
|
@ -184,6 +184,7 @@ namespace Microsoft.AspNetCore.WebUtilities
|
||||||
/// Parses an HTTP form body.
|
/// Parses an HTTP form body.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="stream">The HTTP form body to parse.</param>
|
/// <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>
|
/// <returns>The collection containing the parsed HTTP form body.</returns>
|
||||||
public static Task<Dictionary<string, StringValues>> ReadFormAsync(Stream stream, CancellationToken cancellationToken = new CancellationToken())
|
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.
|
/// Parses an HTTP form body.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="stream">The HTTP form body to parse.</param>
|
/// <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>
|
/// <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())
|
public static async Task<Dictionary<string, StringValues>> ReadFormAsync(Stream stream, Encoding encoding, CancellationToken cancellationToken = new CancellationToken())
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -23,8 +23,9 @@ namespace Microsoft.AspNetCore.WebUtilities
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Creates a stream that reads until it reaches the given boundary pattern.
|
/// Creates a stream that reads until it reaches the given boundary pattern.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="stream"></param>
|
/// <param name="stream">The <see cref="BufferedReadStream"/>.</param>
|
||||||
/// <param name="boundary"></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)
|
public MultipartReaderStream(BufferedReadStream stream, string boundary, bool expectLeadingCrlf = true)
|
||||||
{
|
{
|
||||||
if (stream == null)
|
if (stream == null)
|
||||||
|
|
|
||||||
|
|
@ -156,7 +156,7 @@ namespace Microsoft.AspNetCore.WebUtilities
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets the minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters
|
/// 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>
|
/// </summary>
|
||||||
/// <param name="count">The number of characters to decode.</param>
|
/// <param name="count">The number of characters to decode.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
|
@ -305,7 +305,7 @@ namespace Microsoft.AspNetCore.WebUtilities
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Get the minimum output <c>char[]</c> size required for encoding <paramref name="count"/>
|
/// 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>
|
/// </summary>
|
||||||
/// <param name="count">The number of characters to encode.</param>
|
/// <param name="count">The number of characters to encode.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
|
|
|
||||||
|
|
@ -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.Extensions.Primitives": "1.0.0-*",
|
"Microsoft.Extensions.Primitives": "1.0.0-*",
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,9 @@
|
||||||
},
|
},
|
||||||
"compilationOptions": {
|
"compilationOptions": {
|
||||||
"warningsAsErrors": true,
|
"warningsAsErrors": true,
|
||||||
"keyFile": "../../tools/Key.snk"
|
"keyFile": "../../tools/Key.snk",
|
||||||
|
"nowarn": [ "CS1591" ],
|
||||||
|
"xmlDoc": true
|
||||||
},
|
},
|
||||||
"dependencies": {},
|
"dependencies": {},
|
||||||
"frameworks": {
|
"frameworks": {
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue