Enabled xml doc generation

This commit is contained in:
Ajay Bhargav Baaskaran 2016-02-12 15:16:03 -08:00
parent a0164b005d
commit 54fea50483
9 changed files with 16 additions and 25 deletions

View File

@ -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.Razor": { }, "Microsoft.AspNetCore.Razor": { },
@ -23,12 +18,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

@ -159,7 +159,7 @@ namespace Microsoft.AspNetCore.Razor.Runtime.TagHelpers
} }
/// <summary> /// <summary>
/// Tracks the minimized HTML attribute in <see cref="AllAttributes"/> and <see cref="HtmlAttributes"/>. /// Tracks the minimized HTML attribute.
/// </summary> /// </summary>
/// <param name="name">The minimized HTML attribute name.</param> /// <param name="name">The minimized HTML attribute name.</param>
public void AddMinimizedHtmlAttribute(string name) public void AddMinimizedHtmlAttribute(string name)
@ -178,7 +178,7 @@ namespace Microsoft.AspNetCore.Razor.Runtime.TagHelpers
} }
/// <summary> /// <summary>
/// Tracks the HTML attribute in <see cref="AllAttributes"/> and <see cref="HtmlAttributes"/>. /// Tracks the HTML attribute.
/// </summary> /// </summary>
/// <param name="name">The HTML attribute name.</param> /// <param name="name">The HTML attribute name.</param>
/// <param name="value">The HTML attribute value.</param> /// <param name="value">The HTML attribute value.</param>
@ -198,7 +198,7 @@ namespace Microsoft.AspNetCore.Razor.Runtime.TagHelpers
} }
/// <summary> /// <summary>
/// Tracks the <see cref="ITagHelper"/> bound attribute in <see cref="AllAttributes"/>. /// Tracks the <see cref="ITagHelper"/> bound attribute.
/// </summary> /// </summary>
/// <param name="name">The bound attribute name.</param> /// <param name="name">The bound attribute name.</param>
/// <param name="value">The attribute value.</param> /// <param name="value">The attribute value.</param>

View File

@ -25,7 +25,7 @@ namespace Microsoft.AspNetCore.Razor.TagHelpers
/// </summary> /// </summary>
/// <param name="context">Contains information associated with the current HTML tag.</param> /// <param name="context">Contains information associated with the current HTML tag.</param>
/// <remarks>When more than one <see cref="ITagHelper"/> runs on the same element, /// <remarks>When more than one <see cref="ITagHelper"/> runs on the same element,
/// <see cref="TagHelperOutput.GetChildContentAsync"/> may be invoked prior to <see cref="ProcessAsync"/>. /// <see cref="M:TagHelperOutput.GetChildContentAsync"/> may be invoked prior to <see cref="ProcessAsync"/>.
/// </remarks> /// </remarks>
void Init(TagHelperContext context); void Init(TagHelperContext context);

View File

@ -10,9 +10,6 @@ namespace Microsoft.AspNetCore.Razor.TagHelpers
/// <summary> /// <summary>
/// A read-only collection of <see cref="TagHelperAttribute"/>s. /// A read-only collection of <see cref="TagHelperAttribute"/>s.
/// </summary> /// </summary>
/// <typeparam name="TagHelperAttribute">
/// The type of <see cref="TagHelperAttribute"/>s in the collection.
/// </typeparam>
public abstract class ReadOnlyTagHelperAttributeList : ReadOnlyCollection<TagHelperAttribute> public abstract class ReadOnlyTagHelperAttributeList : ReadOnlyCollection<TagHelperAttribute>
{ {
private static readonly IReadOnlyList<TagHelperAttribute> EmptyList = new TagHelperAttribute[0]; private static readonly IReadOnlyList<TagHelperAttribute> EmptyList = new TagHelperAttribute[0];

View File

@ -49,7 +49,7 @@ namespace Microsoft.AspNetCore.Razor.TagHelpers
/// Gets the collection of items used to communicate with other <see cref="ITagHelper"/>s. /// Gets the collection of items used to communicate with other <see cref="ITagHelper"/>s.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This <see cref="IDictionary{object, object}"/> is copy-on-write in order to ensure items added to this /// This <see cref="IDictionary{Object, Object}" /> is copy-on-write in order to ensure items added to this
/// collection are visible only to other <see cref="ITagHelper"/>s targeting child elements. /// collection are visible only to other <see cref="ITagHelper"/>s targeting child elements.
/// </remarks> /// </remarks>
public IDictionary<object, object> Items { get; } public IDictionary<object, object> Items { get; }

View File

@ -4,7 +4,9 @@
"compilationOptions": { "compilationOptions": {
"allowUnsafe": true, "allowUnsafe": true,
"keyFile": "../../tools/Key.snk", "keyFile": "../../tools/Key.snk",
"warningsAsErrors": true "warningsAsErrors": true,
"nowarn": [ "CS1591" ],
"xmlDoc": true
}, },
"repository": { "repository": {
"type": "git", "type": "git",

View File

@ -29,8 +29,7 @@ namespace Microsoft.AspNetCore.Razor.Parser.TagHelpers
/// <summary> /// <summary>
/// Instantiates a new instance of the <see cref="TagHelperBlockBuilder"/> class /// Instantiates a new instance of the <see cref="TagHelperBlockBuilder"/> class
/// with the provided <paramref name="tagName"/> and derives its <see cref="Attributes"/> /// with the provided values.
/// and <see cref="BlockBuilder.Type"/> from the <paramref name="startTag"/>.
/// </summary> /// </summary>
/// <param name="tagName">An HTML tag name.</param> /// <param name="tagName">An HTML tag name.</param>
/// <param name="tagMode">HTML syntax of the element in the Razor source.</param> /// <param name="tagMode">HTML syntax of the element in the Razor source.</param>

View File

@ -236,7 +236,8 @@ namespace Microsoft.AspNetCore.Razor
/// <summary> /// <summary>
/// Gets an instance of the code generator and is provided an opportunity to decorate or replace it /// Gets an instance of the code generator and is provided an opportunity to decorate or replace it
/// </summary> /// </summary>
/// <param name="incomingBuilder">The code generator</param> /// <param name="incomingBuilder">The <see cref="CodeGenerator"/>.</param>
/// <param name="context">The <see cref="CodeGeneratorContext"/>.</param>
/// <returns>Either the same code generator, after modifications, or a different code generator.</returns> /// <returns>Either the same code generator, after modifications, or a different code generator.</returns>
public virtual CodeGenerator DecorateCodeGenerator( public virtual CodeGenerator DecorateCodeGenerator(
CodeGenerator incomingBuilder, CodeGenerator incomingBuilder,

View File

@ -3,7 +3,9 @@
"version": "1.0.0-*", "version": "1.0.0-*",
"compilationOptions": { "compilationOptions": {
"warningsAsErrors": true, "warningsAsErrors": true,
"keyFile": "../../tools/Key.snk" "keyFile": "../../tools/Key.snk",
"nowarn": [ "CS1591" ],
"xmlDoc": true
}, },
"repository": { "repository": {
"type": "git", "type": "git",