updating inline <code> to <c> (#17611)

* updating inline "code" tag to "c" tag

* Apply suggestions from code review

Co-Authored-By: Andrew Stanton-Nurse <andrew@stanton-nurse.com>

* reverting tag

* reverting tag

* reverting entire file
This commit is contained in:
Eddy Nakamura 2019-12-11 16:47:38 -03:00 committed by Artak
parent 11ecc62ea9
commit 5ff9ed68d1
19 changed files with 58 additions and 58 deletions

View File

@ -1,4 +1,4 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
@ -15,7 +15,7 @@ namespace Microsoft.AspNetCore.Components
/// Constructs an instance of <see cref="BindElementAttribute"/>.
/// </summary>
/// <param name="element">The tag name of the element.</param>
/// <param name="suffix">The suffix value. For example, set this to <code>value</code> for <code>bind-value</code>, or set this to <code>null</code> for <code>bind</code>.</param>
/// <param name="suffix">The suffix value. For example, set this to <c>value</c> for <c>bind-value</c>, or set this to <see langword="null" /> for <c>bind</c>.</param>
/// <param name="valueAttribute">The name of the value attribute to be bound.</param>
/// <param name="changeAttribute">The name of an attribute that will register an associated change event.</param>
public BindElementAttribute(string element, string suffix, string valueAttribute, string changeAttribute)
@ -47,7 +47,7 @@ namespace Microsoft.AspNetCore.Components
/// <summary>
/// Gets the suffix value.
/// For example, this will be <code>value</code> to mean <code>bind-value</code>, or <code>null</code> to mean <code>bind</code>.
/// For example, this will be <c>value</c> to mean <c>bind-value</c>, or <see langword="null" /> to mean <c>bind</c>.
/// </summary>
public string Suffix { get; }

View File

@ -7,7 +7,7 @@ using System.Globalization;
namespace Microsoft.AspNetCore.Components
{
/// <summary>
/// Configures options for binding subtypes of an HTML <code>input</code> element.
/// Configures options for binding subtypes of an HTML <c>input</c> element.
/// </summary>
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class BindInputElementAttribute : Attribute
@ -15,7 +15,7 @@ namespace Microsoft.AspNetCore.Components
/// <summary>
/// Constructs an instance of <see cref="BindInputElementAttribute"/>.
/// </summary>
/// <param name="type">The value of the element's <code>type</code> attribute.</param>
/// <param name="type">The value of the element's <c>type</c> attribute.</param>
/// <param name="suffix">The suffix value.</param>
/// <param name="valueAttribute">The name of the value attribute to be bound.</param>
/// <param name="changeAttribute">The name of an attribute that will register an associated change event.</param>
@ -46,7 +46,7 @@ namespace Microsoft.AspNetCore.Components
}
/// <summary>
/// Gets the value of the element's <code>type</code> attribute.
/// Gets the value of the element's <c>type</c> attribute.
/// </summary>
public string Type { get; }

View File

@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Authentication
/// <summary>
/// Returns true if request processing should stop.
/// </summary>
/// <returns><code>true</code> if request processing should stop.</returns>
/// <returns><see langword="true" /> if request processing should stop.</returns>
Task<bool> HandleRequestAsync();
}

View File

@ -230,8 +230,8 @@ namespace Microsoft.Net.Http.Headers
/// any value originally supplied in result will be overwritten.
/// </param>
/// <returns>
/// <code>true</code> if <paramref name="targetValue"/> is found and successfully parsed; otherwise,
/// <code>false</code>.
/// <see langword="true" /> if <paramref name="targetValue"/> is found and successfully parsed; otherwise,
/// <see langword="false" />.
/// </returns>
// e.g. { "headerValue=10, targetHeaderValue=30" }
public static bool TryParseSeconds(StringValues headerValues, string targetValue, out TimeSpan? value)
@ -286,8 +286,8 @@ namespace Microsoft.Net.Http.Headers
/// The target cache control directives to look for.
/// </param>
/// <returns>
/// <code>true</code> if <paramref name="targetDirectives"/> is contained in <paramref name="cacheControlDirectives"/>;
/// otherwise, <code>false</code>.
/// <see langword="true" /> if <paramref name="targetDirectives"/> is contained in <paramref name="cacheControlDirectives"/>;
/// otherwise, <see langword="false" />.
/// </returns>
public static bool ContainsCacheDirective(StringValues cacheControlDirectives, string targetDirectives)
{
@ -367,7 +367,7 @@ namespace Microsoft.Net.Http.Headers
/// greater than Int64.MaxValue. This parameter is passed uninitialized; any value originally supplied in
/// result will be overwritten.
/// </param>
/// <returns><code>true</code> if parsing succeeded; otherwise, <code>false</code>.</returns>
/// <returns><see langword="true" /> if parsing succeeded; otherwise, <see langword="false" />.</returns>
public static unsafe bool TryParseNonNegativeInt32(StringSegment value, out int result)
{
if (string.IsNullOrEmpty(value.Buffer) || value.Length == 0)
@ -418,7 +418,7 @@ namespace Microsoft.Net.Http.Headers
/// represents a number greater than Int64.MaxValue. This parameter is passed uninitialized; any value
/// originally supplied in result will be overwritten.
/// </param>
/// <returns><code>true</code> if parsing succeeded; otherwise, <code>false</code>.</returns>
/// <returns><see langword="true" /> if parsing succeeded; otherwise, <see langword="false" />.</returns>
public static unsafe bool TryParseNonNegativeInt64(StringSegment value, out long result)
{
if (string.IsNullOrEmpty(value.Buffer) || value.Length == 0)

View File

@ -223,7 +223,7 @@ namespace Microsoft.AspNetCore.Http
/// "abc.example.com:443" but not "example.com:443".
/// Matching is case insensitive.
/// </remarks>
/// <returns><code>true</code> if <paramref name="value"/> matches any of the patterns.</returns>
/// <returns><see langword="true" /> if <paramref name="value"/> matches any of the patterns.</returns>
public static bool MatchesAny(StringSegment value, IList<StringSegment> patterns)
{
if (value == null)
@ -282,7 +282,7 @@ namespace Microsoft.AspNetCore.Http
/// Compares the equality of the Value property, ignoring case.
/// </summary>
/// <param name="other">The <see cref="HostString"/> to compare against.</param>
/// <returns><code>true</code> if they have the same value.</returns>
/// <returns><see langword="true" /> if they have the same value.</returns>
public bool Equals(HostString other)
{
if (!HasValue && !other.HasValue)
@ -296,7 +296,7 @@ namespace Microsoft.AspNetCore.Http
/// Compares against the given object only if it is a HostString.
/// </summary>
/// <param name="obj">The <see cref="object"/> to compare against.</param>
/// <returns><code>true</code> if they have the same value.</returns>
/// <returns><see langword="true" /> if they have the same value.</returns>
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj))
@ -320,7 +320,7 @@ namespace Microsoft.AspNetCore.Http
/// </summary>
/// <param name="left">The left parameter.</param>
/// <param name="right">The right parameter.</param>
/// <returns><code>true</code> if both <see cref="HostString"/>'s have the same value.</returns>
/// <returns><see langword="true" /> if both <see cref="HostString"/>'s have the same value.</returns>
public static bool operator ==(HostString left, HostString right)
{
return left.Equals(right);
@ -331,7 +331,7 @@ namespace Microsoft.AspNetCore.Http
/// </summary>
/// <param name="left">The left parameter.</param>
/// <param name="right">The right parameter.</param>
/// <returns><code>true</code> if both <see cref="HostString"/>'s values are not equal.</returns>
/// <returns><see langword="true" /> if both <see cref="HostString"/>'s values are not equal.</returns>
public static bool operator !=(HostString left, HostString right)
{
return !left.Equals(right);

View File

@ -282,7 +282,7 @@ namespace Microsoft.AspNetCore.Http.Headers
/// <summary>
/// Gets the value of header with <paramref name="name"/>.
/// </summary>
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <code>public static bool TryParse(string, out T)</code>.</remarks>
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <c>public static bool TryParse(string, out T)</c>.</remarks>
/// <typeparam name="T">The type of the header.
/// The given type must have a static TryParse method.</typeparam>
/// <param name="name">The name of the header to retrieve.</param>
@ -295,7 +295,7 @@ namespace Microsoft.AspNetCore.Http.Headers
/// <summary>
/// Gets the values of header with <paramref name="name"/>.
/// </summary>
/// <remarks><typeparamref name="T"/> must contain a TryParseList method with the signature <code>public static bool TryParseList(IList&lt;string&gt;, out IList&lt;T&gt;)</code>.</remarks>
/// <remarks><typeparamref name="T"/> must contain a TryParseList method with the signature <c>public static bool TryParseList(IList&lt;string&gt;, out IList&lt;T&gt;)</c>.</remarks>
/// <typeparam name="T">The type of the header.
/// The given type must have a static TryParseList method.</typeparam>
/// <param name="name">The name of the header to retrieve.</param>

View File

@ -161,7 +161,7 @@ namespace Microsoft.AspNetCore.Http.Headers
/// <summary>
/// Gets the value of header with <paramref name="name"/>.
/// </summary>
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <code>public static bool TryParse(string, out T)</code>.</remarks>
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <c>public static bool TryParse(string, out T)</c>.</remarks>
/// <typeparam name="T">The type of the header.
/// The given type must have a static TryParse method.</typeparam>
/// <param name="name">The name of the header to retrieve.</param>
@ -174,7 +174,7 @@ namespace Microsoft.AspNetCore.Http.Headers
/// <summary>
/// Gets the values of header with <paramref name="name"/>.
/// </summary>
/// <remarks><typeparamref name="T"/> must contain a TryParseList method with the signature <code>public static bool TryParseList(IList&lt;string&gt;, out IList&lt;T&gt;)</code>.</remarks>
/// <remarks><typeparamref name="T"/> must contain a TryParseList method with the signature <c>public static bool TryParseList(IList&lt;string&gt;, out IList&lt;T&gt;)</c>.</remarks>
/// <typeparam name="T">The type of the header.
/// The given type must have a static TryParseList method.</typeparam>
/// <param name="name">The name of the header to retrieve.</param>

View File

@ -90,8 +90,8 @@ namespace Microsoft.AspNetCore.Routing
/// <remarks>
/// If the <paramref name="value"/> is a string, it will be converted to a <see cref="RegexRouteConstraint"/>.
///
/// For example, the string <code>Product[0-9]+</code> will be converted to the regular expression
/// <code>^(Product[0-9]+)</code>. See <see cref="System.Text.RegularExpressions.Regex"/> for more details.
/// For example, the string <c>Product[0-9]+</c> will be converted to the regular expression
/// <c>^(Product[0-9]+)</c>. See <see cref="System.Text.RegularExpressions.Regex"/> for more details.
/// </remarks>
public void AddConstraint(string key, object value)
{

View File

@ -81,7 +81,7 @@ namespace Microsoft.AspNetCore.Mvc.ModelBinding
/// <see cref="ModelStateDictionary"/> tracks the number of model errors added by calls to
/// <see cref="AddModelError(string, Exception, ModelMetadata)"/> or
/// <see cref="TryAddModelError(string, Exception, ModelMetadata)"/>.
/// Once the value of <code>MaxAllowedErrors - 1</code> is reached, if another attempt is made to add an error,
/// Once the value of <c>MaxAllowedErrors - 1</c> is reached, if another attempt is made to add an error,
/// the error message will be ignored and a <see cref="TooManyModelErrorsException"/> will be added.
/// </para>
/// <para>

View File

@ -1,4 +1,4 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
@ -37,7 +37,7 @@ namespace Microsoft.AspNetCore.Mvc.Controllers
/// Determines if a given <paramref name="typeInfo"/> is a controller.
/// </summary>
/// <param name="typeInfo">The <see cref="TypeInfo"/> candidate.</param>
/// <returns><code>true</code> if the type is a controller; otherwise <code>false</code>.</returns>
/// <returns><see langword="true" /> if the type is a controller; otherwise <see langword="false" />.</returns>
protected virtual bool IsController(TypeInfo typeInfo)
{
if (!typeInfo.IsClass)

View File

@ -50,8 +50,8 @@ namespace Microsoft.AspNetCore.Mvc.Formatters
/// Removes the first occurrence of a specific media type from the <see cref="MediaTypeCollection"/>.
/// </summary>
/// <param name="item"></param>
/// <returns><code>true</code> if <paramref name="item"/> is successfully removed; otherwise, <code>false</code>.
/// This method also returns <code>false</code> if <paramref name="item"/> was not found in the original
/// <returns><see langword="true" /> if <paramref name="item"/> is successfully removed; otherwise, <see langword="false" />.
/// This method also returns <see langword="false" /> if <paramref name="item"/> was not found in the original
/// <see cref="MediaTypeCollection"/>.</returns>
public bool Remove(MediaTypeHeaderValue item)
{

View File

@ -25,7 +25,7 @@ namespace Microsoft.AspNetCore.Mvc.Routing
/// <see cref="ControllerActionDescriptor.ActionName"/>
/// </para>
/// <example>
/// For an action like <code>MyApp.Controllers.HomeController.Index()</code>, in order to be selected, the
/// For an action like <c>MyApp.Controllers.HomeController.Index()</c>, in order to be selected, the
/// <see cref="RouteData.Values"/> must contain the values
/// {
/// "action": "Index",
@ -39,11 +39,11 @@ namespace Microsoft.AspNetCore.Mvc.Routing
/// <see cref="IRouteValueProvider"/>) or are considered 'outside' of areas by having the value <c>null</c>.
/// </para>
/// <example>
/// Consider an application with two controllers, each with an <code>Index</code> action method:
/// - <code>MyApp.Controllers.HomeController.Index()</code>
/// - <code>MyApp.Areas.Blog.Controllers.HomeController.Index()</code>
/// where <code>MyApp.Areas.Blog.Controllers.HomeController</code> has an area attribute
/// <code>[Area("Blog")]</code>.
/// Consider an application with two controllers, each with an <c>Index</c> action method:
/// - <c>MyApp.Controllers.HomeController.Index()</c>
/// - <c>MyApp.Areas.Blog.Controllers.HomeController.Index()</c>
/// where <c>MyApp.Areas.Blog.Controllers.HomeController</c> has an area attribute
/// <c>[Area("Blog")]</c>.
///
/// For <see cref="RouteData.Values"/> like:
/// {
@ -51,8 +51,8 @@ namespace Microsoft.AspNetCore.Mvc.Routing
/// "controller": "Home"
/// }
///
/// <code>MyApp.Controllers.HomeController.Index()</code> will be selected.
/// <code>MyApp.Area.Blog.Controllers.HomeController.Index()</code> is not considered eligible because the
/// <c>MyApp.Controllers.HomeController.Index()</c> will be selected.
/// <c>MyApp.Area.Blog.Controllers.HomeController.Index()</c> is not considered eligible because the
/// <see cref="RouteData.Values"/> does not contain the value 'Blog' for 'area'.
///
/// For <see cref="RouteData.Values"/> like:
@ -62,9 +62,9 @@ namespace Microsoft.AspNetCore.Mvc.Routing
/// "controller": "Home"
/// }
///
/// <code>MyApp.Area.Blog.Controllers.HomeController.Index()</code> will be selected.
/// <code>MyApp.Controllers.HomeController.Index()</code> is not considered eligible because the route values
/// contain a value for 'area'. <code>MyApp.Controllers.HomeController.Index()</code> cannot match any value
/// <c>MyApp.Area.Blog.Controllers.HomeController.Index()</c> will be selected.
/// <c>MyApp.Controllers.HomeController.Index()</c> is not considered eligible because the route values
/// contain a value for 'area'. <c>MyApp.Controllers.HomeController.Index()</c> cannot match any value
/// for 'area' other than <c>null</c>.
/// </example>
/// </remarks>

View File

@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor.Internal
/// <summary>
/// Specifies that the attributed property should be bound using request services.
/// <para>
/// This attribute is used as the backing attribute for the <code>@inject</code>
/// This attribute is used as the backing attribute for the <c>@inject</c>
/// Razor directive.
/// </para>
/// </summary>

View File

@ -1,4 +1,4 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
@ -16,7 +16,7 @@ namespace Microsoft.AspNetCore.Mvc.Testing
/// <see cref="Key"/> is equal to <c>TEntryPoint</c> <see cref="Assembly.FullName"/>,
/// order them by <see cref="Priority"/> in ascending order.
/// <see cref="WebApplicationFactory{TEntryPoint}"/> will check for the existence of the marker
/// in <code>Path.Combine(<see cref="ContentRootPath"/>, Path.GetFileName(<see cref="ContentRootTest"/>))"</code>
/// in <c>Path.Combine(<see cref="ContentRootPath"/>, Path.GetFileName(<see cref="ContentRootTest"/>))"</c>
/// and if the file exists it will set the content root to <see cref="ContentRootPath"/>.
/// </summary>
[AttributeUsage(AttributeTargets.Assembly, Inherited = false, AllowMultiple = true)]
@ -33,7 +33,7 @@ namespace Microsoft.AspNetCore.Mvc.Testing
/// </param>
/// <param name="contentRootPath">The path to the content root. This path can be either relative or absolute.
/// In case the path is relative, the path will be combined with
/// <code><see cref="Directory.GetCurrentDirectory()"/></code></param>
/// <see cref="Directory.GetCurrentDirectory()"/></param>
/// <param name="contentRootTest">
/// A file that will be use as a marker to determine that the content root path for the given context is correct.
/// </param>

View File

@ -12,7 +12,7 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
{
/// <summary>
/// Represents a list that lets users select multiple items.
/// This class is typically rendered as an HTML <code>&lt;select multiple="multiple"&gt;</code> element with the specified collection
/// This class is typically rendered as an HTML <c>&lt;select multiple="multiple"&gt;</c> element with the specified collection
/// of <see cref="SelectListItem"/> objects.
/// </summary>
public class MultiSelectList : IEnumerable<SelectListItem>

View File

@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
{
/// <summary>
/// Represents a list that lets users select a single item.
/// This class is typically rendered as an HTML <code>&lt;select&gt;</code> element with the specified collection
/// This class is typically rendered as an HTML <c>&lt;select&gt;</c> element with the specified collection
/// of <see cref="SelectListItem"/> objects.
/// </summary>
public class SelectList : MultiSelectList

View File

@ -5,7 +5,7 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
{
/// <summary>
/// Represents an item in a <see cref="SelectList"/> or <see cref="MultiSelectList"/>.
/// This class is typically rendered as an HTML <code>&lt;option&gt;</code> element with the specified
/// This class is typically rendered as an HTML <c>&lt;option&gt;</c> element with the specified
/// attribute values.
/// </summary>
public class SelectListItem
@ -54,8 +54,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <summary>
/// Gets or sets a value that indicates whether this <see cref="SelectListItem"/> is disabled.
/// This property is typically rendered as a <code>disabled="disabled"</code> attribute in the HTML
/// <code>&lt;option&gt;</code> element.
/// This property is typically rendered as a <c>disabled="disabled"</c> attribute in the HTML
/// <c>&lt;option&gt;</c> element.
/// </summary>
public bool Disabled { get; set; }
@ -68,21 +68,21 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <summary>
/// Gets or sets a value that indicates whether this <see cref="SelectListItem"/> is selected.
/// This property is typically rendered as a <code>selected="selected"</code> attribute in the HTML
/// <code>&lt;option&gt;</code> element.
/// This property is typically rendered as a <c>selected="selected"</c> attribute in the HTML
/// <c>&lt;option&gt;</c> element.
/// </summary>
public bool Selected { get; set; }
/// <summary>
/// Gets or sets a value that indicates the display text of this <see cref="SelectListItem"/>.
/// This property is typically rendered as the inner HTML in the HTML <code>&lt;option&gt;</code> element.
/// This property is typically rendered as the inner HTML in the HTML <c>&lt;option&gt;</c> element.
/// </summary>
public string Text { get; set; }
/// <summary>
/// Gets or sets a value that indicates the value of this <see cref="SelectListItem"/>.
/// This property is typically rendered as a <code>value="..."</code> attribute in the HTML
/// <code>&lt;option&gt;</code> element.
/// This property is typically rendered as a <c>value="..."</c> attribute in the HTML
/// <c>&lt;option&gt;</c> element.
/// </summary>
public string Value { get; set; }
}

View File

@ -57,7 +57,7 @@ namespace Microsoft.AspNetCore.Mvc.ViewComponents
/// <para>
/// The full name is defaulted to the full namespace of the view component class, prepended to
/// the class name with a '.' character as the separator. If the view component class uses
/// <code>ViewComponent</code> as a suffix, the suffix will be omitted from the <see cref="FullName"/>.
/// <c>ViewComponent</c> as a suffix, the suffix will be omitted from the <see cref="FullName"/>.
/// </para>
/// <example>
/// Class Name: Contoso.Products.LoginViewComponent
@ -92,7 +92,7 @@ namespace Microsoft.AspNetCore.Mvc.ViewComponents
/// <remarks>
/// <para>
/// The short name is defaulted to the name of the view component class. If the view component class uses
/// <code>ViewComponent</code> as a suffix, the suffix will be omitted from the <see cref="ShortName"/>.
/// <c>ViewComponent</c> as a suffix, the suffix will be omitted from the <see cref="ShortName"/>.
/// </para>
/// <example>
/// Class Name: Contoso.Products.LoginViewComponent

View File

@ -1,4 +1,4 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
@ -54,7 +54,7 @@ namespace Microsoft.AspNetCore.Authentication.WsFederation
/// <summary>
/// Overridden to handle remote signout requests
/// </summary>
/// <returns><code>true</code> if request processing should stop.</returns>
/// <returns><see langword="true" /> if request processing should stop.</returns>
public override Task<bool> HandleRequestAsync()
{
// RemoteSignOutPath and CallbackPath may be the same, fall through if the message doesn't match.