huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve `[HtmlTargetElement]` doc comments 

- #562
This commit is contained in:
Doug Bunting 2015-10-23 14:48:13 -07:00
parent 42d41a0049
commit 1c7af0de6c
2 changed files with 13 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/Microsoft.AspNet.Razor.Runtime/TagHelpers/HtmlTargetElementAttribute.cs
View File

@ -15,47 +15,43 @@ namespace Microsoft.AspNet.Razor.TagHelpers
public const string ElementCatchAllTarget = TagHelperDescriptorProvider.ElementCatchAllTarget; public const string ElementCatchAllTarget = TagHelperDescriptorProvider.ElementCatchAllTarget;
/// <summary> /// <summary>
/// Instantiates a new instance of the <see cref="HtmlTargetElementAttribute"/> class with <see cref="Tag"/> /// Instantiates a new instance of the <see cref="HtmlTargetElementAttribute"/> class that targets all HTML
/// set to <c>*</c>. /// elements with the required <see cref="Attributes"/>.
/// </summary> /// </summary>
/// <remarks>A <c>*</c> <see cref="Tag"/> value indicates an <see cref="ITagHelper"/> /// <remarks><see cref="Tag"/> is set to <c>*</c>.</remarks>
/// that targets all HTML elements with the required <see cref="Attributes"/>.</remarks>
public HtmlTargetElementAttribute() public HtmlTargetElementAttribute()
: this(ElementCatchAllTarget) : this(ElementCatchAllTarget)
{ {
} }
/// <summary> /// <summary>
/// Instantiates a new instance of the <see cref="HtmlTargetElementAttribute"/> class. /// Instantiates a new instance of the <see cref="HtmlTargetElementAttribute"/> class with the given
/// <paramref name="tag"/> as its <see cref="Tag"/> value.
/// </summary> /// </summary>
/// <param name="tag"> /// <param name="tag">
/// The HTML tag the <see cref="ITagHelper"/> targets. /// The HTML tag the <see cref="ITagHelper"/> targets.
/// </param> /// </param>
/// <remarks>A <c>*</c> <paramref name="tag"/> value indicates an <see cref="ITagHelper"/> /// <remarks>A <c>*</c> <paramref name="tag"/> value indicates this <see cref="ITagHelper"/>
/// that targets all HTML elements with the required <see cref="Attributes"/>.</remarks> /// targets all HTML elements with the required <see cref="Attributes"/>.</remarks>
public HtmlTargetElementAttribute(string tag) public HtmlTargetElementAttribute(string tag)
{ {
Tag = tag; Tag = tag;
} }
/// <summary> /// <summary>
/// The HTML tag the <see cref="ITagHelper"/> targets. /// The HTML tag the <see cref="ITagHelper"/> targets. A <c>*</c> value indicates this <see cref="ITagHelper"/>
/// targets all HTML elements with the required <see cref="Attributes"/>.
/// </summary> /// </summary>
/// <remarks>A <c>*</c> <see cref="Tag"/> value indicates an <see cref="ITagHelper"/>
/// that targets all HTML elements with the required <see cref="Attributes"/>.</remarks>
public string Tag { get; } public string Tag { get; }
/// <summary> /// <summary>
/// A comma-separated <see cref="string"/> of attribute names the HTML element must contain for the /// A comma-separated <see cref="string"/> of attribute names the HTML element must contain for the
/// <see cref="ITagHelper"/> to run. /// <see cref="ITagHelper"/> to run. <c>*</c> at the end of an attribute name acts as a prefix match.
/// </summary> /// </summary>
/// <remarks>
/// <c>*</c> at the end of an attribute name acts as a prefix match.
/// </remarks>
public string Attributes { get; set; } public string Attributes { get; set; }
/// <summary> /// <summary>
/// The expected tag structure. /// The expected tag structure. Defaults to <see cref="TagStructure.Unspecified"/>.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// If <see cref="TagStructure.Unspecified"/> and no other tag helpers applying to the same element specify /// If <see cref="TagStructure.Unspecified"/> and no other tag helpers applying to the same element specify
@ -81,9 +77,9 @@ namespace Microsoft.AspNet.Razor.TagHelpers
public TagStructure TagStructure { get; set; } public TagStructure TagStructure { get; set; }
/// <summary> /// <summary>
/// The required HTML element name of the direct parent. /// The required HTML element name of the direct parent. A <c>null</c> value indicates any HTML element name is
/// allowed.
/// </summary> /// </summary>
/// <remarks>A <c>null</c> value indicates any HTML element name is appropriate.</remarks>
public string ParentTag { get; set; } public string ParentTag { get; set; }
} }
} }

1
src/Microsoft.AspNet.Razor.Runtime/TagHelpers/TagHelperOutput.cs
View File

@ -3,7 +3,6 @@
using System; using System;
using System.Threading.Tasks; using System.Threading.Tasks;
using Microsoft.AspNet.Razor.Runtime.TagHelpers;
namespace Microsoft.AspNet.Razor.TagHelpers namespace Microsoft.AspNet.Razor.TagHelpers
{ {