diff --git a/makefile.shade b/makefile.shade index 562494d1..d5e473d5 100644 --- a/makefile.shade +++ b/makefile.shade @@ -5,3 +5,6 @@ var AUTHORS='Microsoft Open Technologies, Inc.' use-standard-lifecycle k-standard-goals + +#xml-docs-test .clean .build-compile description='Check generated XML documentation files for errors' target='package' + k-xml-docs-test diff --git a/src/Microsoft.AspNet.Html.Abstractions/HtmlContentBuilderExtensions.cs b/src/Microsoft.AspNet.Html.Abstractions/HtmlContentBuilderExtensions.cs index 5f8515bb..ef7f9322 100644 --- a/src/Microsoft.AspNet.Html.Abstractions/HtmlContentBuilderExtensions.cs +++ b/src/Microsoft.AspNet.Html.Abstractions/HtmlContentBuilderExtensions.cs @@ -5,7 +5,6 @@ using System.Diagnostics; using System.Globalization; using System.IO; -using System.Text; using Microsoft.Extensions.WebEncoders; namespace Microsoft.AspNet.Html.Abstractions @@ -20,6 +19,7 @@ public static class HtmlContentBuilderExtensions /// item with the HTML encoded representation of the corresponding item in the /// array. /// + /// The . /// /// The composite format (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx). /// The format string is assumed to be HTML encoded as-provided, and no further encoding will be performed. @@ -54,9 +54,10 @@ public static IHtmlContentBuilder AppendFormat( /// /// Appends the specified to the existing content with information from the - /// after replacing each format item with the HTML encoded - /// representation of the corresponding item in the array. + /// after replacing each format item with the HTML encoded + /// representation of the corresponding item in the array. /// + /// The . /// An object that supplies culture-specific formatting information. /// /// The composite format (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx). @@ -122,9 +123,9 @@ public static IHtmlContentBuilder AppendLine(this IHtmlContentBuilder builder, s /// The . /// The to append. /// The . - public static IHtmlContentBuilder AppendLine(this IHtmlContentBuilder builder, IHtmlContent htmlContent) + public static IHtmlContentBuilder AppendLine(this IHtmlContentBuilder builder, IHtmlContent content) { - builder.Append(htmlContent); + builder.Append(content); builder.Append(HtmlEncodedString.NewLine); return builder; } @@ -134,11 +135,11 @@ public static IHtmlContentBuilder AppendLine(this IHtmlContentBuilder builder, I /// The value is treated as HTML encoded as-provided, and no further encoding will be performed. /// /// The . - /// The HTML encoded to append. + /// The HTML encoded to append. /// The . - public static IHtmlContentBuilder AppendLineEncoded(this IHtmlContentBuilder builder, string encoded) + public static IHtmlContentBuilder AppendHtmlLine(this IHtmlContentBuilder builder, string encoded) { - builder.AppendEncoded(encoded); + builder.AppendHtml(encoded); builder.Append(HtmlEncodedString.NewLine); return builder; } @@ -148,7 +149,7 @@ public static IHtmlContentBuilder AppendLineEncoded(this IHtmlContentBuilder bui /// and will be HTML encoded before writing to output. /// /// The . - /// The value that replaces the content. + /// The value that replaces the content. /// The . public static IHtmlContentBuilder SetContent(this IHtmlContentBuilder builder, string unencoded) { @@ -161,7 +162,7 @@ public static IHtmlContentBuilder SetContent(this IHtmlContentBuilder builder, s /// Sets the content to the value. /// /// The . - /// The value that replaces the content. + /// The value that replaces the content. /// The . public static IHtmlContentBuilder SetContent(this IHtmlContentBuilder builder, IHtmlContent content) { @@ -175,12 +176,12 @@ public static IHtmlContentBuilder SetContent(this IHtmlContentBuilder builder, I /// no further encoding will be performed. /// /// The . - /// The HTML encoded that replaces the content. + /// The HTML encoded that replaces the content. /// The . - public static IHtmlContentBuilder SetContentEncoded(this IHtmlContentBuilder builder, string encoded) + public static IHtmlContentBuilder SetHtmlContent(this IHtmlContentBuilder builder, string encoded) { builder.Clear(); - builder.AppendEncoded(encoded); + builder.AppendHtml(encoded); return builder; } diff --git a/src/Microsoft.AspNet.Html.Abstractions/IHtmlContentBuilder.cs b/src/Microsoft.AspNet.Html.Abstractions/IHtmlContentBuilder.cs index ced5bd76..e55cec35 100644 --- a/src/Microsoft.AspNet.Html.Abstractions/IHtmlContentBuilder.cs +++ b/src/Microsoft.AspNet.Html.Abstractions/IHtmlContentBuilder.cs @@ -29,7 +29,7 @@ public interface IHtmlContentBuilder : IHtmlContent /// /// The HTML encoded to append. /// The . - IHtmlContentBuilder AppendEncoded(string encoded); + IHtmlContentBuilder AppendHtml(string encoded); /// /// Clears the content. diff --git a/src/Microsoft.Extensions.BufferedHtmlContent.Sources/BufferedHtmlContent.cs b/src/Microsoft.Extensions.BufferedHtmlContent.Sources/BufferedHtmlContent.cs index 3b79916d..9d098518 100644 --- a/src/Microsoft.Extensions.BufferedHtmlContent.Sources/BufferedHtmlContent.cs +++ b/src/Microsoft.Extensions.BufferedHtmlContent.Sources/BufferedHtmlContent.cs @@ -24,11 +24,11 @@ internal class BufferedHtmlContent : IHtmlContentBuilder /// /// Appends the to the collection. /// - /// The string to be appended. + /// The string to be appended. /// A reference to this instance after the Append operation has completed. - public IHtmlContentBuilder Append(string value) + public IHtmlContentBuilder Append(string unencoded) { - Entries.Add(value); + Entries.Add(unencoded); return this; } @@ -46,11 +46,11 @@ public IHtmlContentBuilder Append(IHtmlContent htmlContent) /// /// Appends the HTML encoded to the collection. /// - /// The HTML encoded string to be appended. + /// The HTML encoded string to be appended. /// A reference to this instance after the Append operation has completed. - public IHtmlContentBuilder AppendEncoded(string value) + public IHtmlContentBuilder AppendHtml(string encoded) { - Entries.Add(new HtmlEncodedString(value)); + Entries.Add(new HtmlEncodedString(encoded)); return this; } /// @@ -95,7 +95,7 @@ public void WriteTo(TextWriter writer, IHtmlEncoder encoder) } } } - + private string DebuggerToString() { using (var writer = new StringWriter()) diff --git a/test/Microsoft.AspNet.Html.Abstractions.Test/HtmlContentBuilderExtensionsTest.cs b/test/Microsoft.AspNet.Html.Abstractions.Test/HtmlContentBuilderExtensionsTest.cs index b1a8fab4..8221fa52 100644 --- a/test/Microsoft.AspNet.Html.Abstractions.Test/HtmlContentBuilderExtensionsTest.cs +++ b/test/Microsoft.AspNet.Html.Abstractions.Test/HtmlContentBuilderExtensionsTest.cs @@ -62,13 +62,13 @@ public void Builder_AppendLine_IHtmlContent() } [Fact] - public void Builder_AppendLineEncoded_String() + public void Builder_AppendHtmlLine_String() { // Arrange var builder = new TestHtmlContentBuilder(); // Act - builder.AppendLineEncoded("Hi"); + builder.AppendHtmlLine("Hi"); // Assert Assert.Collection( @@ -112,14 +112,14 @@ public void Builder_SetContent_IHtmlContent() } [Fact] - public void Builder_SetContentEncoded_String() + public void Builder_SetHtmlContent_String() { // Arrange var builder = new TestHtmlContentBuilder(); builder.Append("Existing Content. Will be Cleared."); // Act - builder.SetContentEncoded("Hi"); + builder.SetHtmlContent("Hi"); // Assert Assert.Collection( @@ -366,7 +366,7 @@ public IHtmlContentBuilder Append(IHtmlContent content) return this; } - public IHtmlContentBuilder AppendEncoded(string encoded) + public IHtmlContentBuilder AppendHtml(string encoded) { Entries.Add(new EncodedString(encoded)); return this; diff --git a/test/Microsoft.Extensions.BufferedHtmlContent.Test/BufferedHtmlContentTest.cs b/test/Microsoft.Extensions.BufferedHtmlContent.Test/BufferedHtmlContentTest.cs index e883f849..2eebd604 100644 --- a/test/Microsoft.Extensions.BufferedHtmlContent.Test/BufferedHtmlContentTest.cs +++ b/test/Microsoft.Extensions.BufferedHtmlContent.Test/BufferedHtmlContentTest.cs @@ -41,11 +41,11 @@ public void AppendString_WrittenAsEncoded() } [Fact] - public void AppendEncoded_DoesNotGetWrittenAsEncoded() + public void AppendHtml_DoesNotGetWrittenAsEncoded() { // Arrange var content = new BufferedHtmlContent(); - content.AppendEncoded("Hello"); + content.AppendHtml("Hello"); var writer = new StringWriter();