Skip to content

updating inline <code> to <c> #17611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 11, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ Ensure your browser is running with debugging enabled.
await context.Response.WriteAsync($@"
<h1>Unable to find debuggable browser tab</h1>
<p>
The response from <code>{debuggerTabsListUrl}</code> does not include
any entry for <code>{targetTabUrl}</code>.
The response from <c>{debuggerTabsListUrl}</c> does not include
any entry for <c>{targetTabUrl}</c>.
</p>");
return;
}
Expand All @@ -135,7 +135,7 @@ The response from <code>{debuggerTabsListUrl}</code> does not include
await context.Response.WriteAsync($@"
<h1>Multiple matching tabs are open</h1>
<p>
There is more than one browser tab at <code>{targetTabUrl}</code>.
There is more than one browser tab at <c>{targetTabUrl}</c>.
Close the ones you do not wish to debug, then refresh this page.
</p>");
return;
Expand All @@ -158,17 +158,17 @@ private static string GetLaunchChromeInstructions(string appRootUrl)
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
return $@"<p>Press Win+R and enter the following:</p>
<p><strong><code>chrome --remote-debugging-port=9222 --user-data-dir=""{profilePath}"" {appRootUrl}</code></strong></p>";
<p><strong><c>chrome --remote-debugging-port=9222 --user-data-dir=""{profilePath}"" {appRootUrl}</c></strong></p>";
}
else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
return $@"<p>In a terminal window execute the following:</p>
<p><strong><code>google-chrome --remote-debugging-port=9222 --user-data-dir={profilePath} {appRootUrl}</code></strong></p>";
<p><strong><c>google-chrome --remote-debugging-port=9222 --user-data-dir={profilePath} {appRootUrl}</c></strong></p>";
}
else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
{
return $@"<p>Execute the following:</p>
<p><strong><code>open /Applications/Google\ Chrome.app --args --remote-debugging-port=9222 --user-data-dir={profilePath} {appRootUrl}</code></strong></p>";
<p><strong><c>open /Applications/Google\ Chrome.app --args --remote-debugging-port=9222 --user-data-dir={profilePath} {appRootUrl}</c></strong></p>";
}
else
{
Expand All @@ -183,12 +183,12 @@ private static string GetLaunchEdgeInstructions(string appRootUrl)
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
return $@"<p>Press Win+R and enter the following:</p>
<p><strong><code>msedge --remote-debugging-port=9222 --user-data-dir=""{profilePath}"" {appRootUrl}</code></strong></p>";
<p><strong><c>msedge --remote-debugging-port=9222 --user-data-dir=""{profilePath}"" {appRootUrl}</c></strong></p>";
}
else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
{
return $@"<p>In a terminal window execute the following:</p>
<p><strong><code>open /Applications/Microsoft\ Edge\ Dev.app --args --remote-debugging-port=9222 --user-data-dir={profilePath} {appRootUrl}</code></strong></p>";
<p><strong><c>open /Applications/Microsoft\ Edge\ Dev.app --args --remote-debugging-port=9222 --user-data-dir={profilePath} {appRootUrl}</c></strong></p>";
}
else
{
Expand Down
6 changes: 3 additions & 3 deletions src/Components/Components/src/BindElementAttribute.cs
Original file line number Diff line number Diff line change
@@ -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;
Expand All @@ -15,7 +15,7 @@ public sealed class BindElementAttribute : Attribute
/// 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)
Expand Down Expand Up @@ -47,7 +47,7 @@ public BindElementAttribute(string element, string suffix, string valueAttribute

/// <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; }

Expand Down
6 changes: 3 additions & 3 deletions src/Components/Web/src/BindInputElementAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
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
{
/// <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>
Expand Down Expand Up @@ -46,7 +46,7 @@ public BindInputElementAttribute(string type, string suffix, string valueAttribu
}

/// <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; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public interface IAuthenticationRequestHandler : IAuthenticationHandler
/// <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();
}

Expand Down
12 changes: 6 additions & 6 deletions src/Http/Headers/src/HeaderUtilities.cs
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,8 @@ private static int AdvanceCacheDirectiveIndex(int current, string headerValue)
/// 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)
Expand Down Expand Up @@ -286,8 +286,8 @@ public static bool TryParseSeconds(StringValues headerValues, string targetValue
/// 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)
{
Expand Down Expand Up @@ -367,7 +367,7 @@ private static unsafe bool TryParseNonNegativeInt64FromHeaderValue(int startInde
/// 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)
Expand Down Expand Up @@ -418,7 +418,7 @@ public static unsafe bool TryParseNonNegativeInt32(StringSegment value, out int
/// 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)
Expand Down
10 changes: 5 additions & 5 deletions src/Http/Http.Abstractions/src/HostString.cs
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ public static HostString FromUriComponent(Uri uri)
/// "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)
Expand Down Expand Up @@ -282,7 +282,7 @@ public static bool MatchesAny(StringSegment value, IList<StringSegment> patterns
/// 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)
Expand All @@ -296,7 +296,7 @@ public bool Equals(HostString other)
/// 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))
Expand All @@ -320,7 +320,7 @@ public override int GetHashCode()
/// </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);
Expand All @@ -331,7 +331,7 @@ public override int GetHashCode()
/// </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);
Expand Down
4 changes: 2 additions & 2 deletions src/Http/Http.Extensions/src/RequestHeaders.cs
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ public Uri Referer
/// <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>
Expand All @@ -295,7 +295,7 @@ public T Get<T>(string name)
/// <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>
Expand Down
4 changes: 2 additions & 2 deletions src/Http/Http.Extensions/src/ResponseHeaders.cs
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public IList<SetCookieHeaderValue> SetCookie
/// <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>
Expand All @@ -174,7 +174,7 @@ public T Get<T>(string name)
/// <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>
Expand Down
4 changes: 2 additions & 2 deletions src/Http/Routing/src/RouteConstraintBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ public IDictionary<string, IRouteConstraint> Build()
/// <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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public ModelStateDictionary(ModelStateDictionary dictionary)
/// <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>
Expand Down
4 changes: 2 additions & 2 deletions src/Mvc/Mvc.Core/src/Controllers/ControllerFeatureProvider.cs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down Expand Up @@ -37,7 +37,7 @@ public void PopulateFeature(
/// 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)
Expand Down
4 changes: 2 additions & 2 deletions src/Mvc/Mvc.Core/src/Formatters/MediaTypeCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ public void Insert(int index, MediaTypeHeaderValue item)
/// 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)
{
Expand Down
Loading