Skip to content

Commit 5ff9ed6

Browse files
eddynakamkArtakMSFT
authored andcommitted
updating inline <code> to <c> (#17611)
* updating inline "code" tag to "c" tag * Apply suggestions from code review Co-Authored-By: Andrew Stanton-Nurse <[email protected]> * reverting tag * reverting tag * reverting entire file
1 parent 11ecc62 commit 5ff9ed6

File tree

19 files changed

+58
-58
lines changed

19 files changed

+58
-58
lines changed

src/Components/Components/src/BindElementAttribute.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) .NET Foundation. All rights reserved.
1+
// Copyright (c) .NET Foundation. All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System;
@@ -15,7 +15,7 @@ public sealed class BindElementAttribute : Attribute
1515
/// Constructs an instance of <see cref="BindElementAttribute"/>.
1616
/// </summary>
1717
/// <param name="element">The tag name of the element.</param>
18-
/// <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>
18+
/// <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>
1919
/// <param name="valueAttribute">The name of the value attribute to be bound.</param>
2020
/// <param name="changeAttribute">The name of an attribute that will register an associated change event.</param>
2121
public BindElementAttribute(string element, string suffix, string valueAttribute, string changeAttribute)
@@ -47,7 +47,7 @@ public BindElementAttribute(string element, string suffix, string valueAttribute
4747

4848
/// <summary>
4949
/// Gets the suffix value.
50-
/// For example, this will be <code>value</code> to mean <code>bind-value</code>, or <code>null</code> to mean <code>bind</code>.
50+
/// For example, this will be <c>value</c> to mean <c>bind-value</c>, or <see langword="null" /> to mean <c>bind</c>.
5151
/// </summary>
5252
public string Suffix { get; }
5353

src/Components/Web/src/BindInputElementAttribute.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
namespace Microsoft.AspNetCore.Components
88
{
99
/// <summary>
10-
/// Configures options for binding subtypes of an HTML <code>input</code> element.
10+
/// Configures options for binding subtypes of an HTML <c>input</c> element.
1111
/// </summary>
1212
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
1313
public sealed class BindInputElementAttribute : Attribute
1414
{
1515
/// <summary>
1616
/// Constructs an instance of <see cref="BindInputElementAttribute"/>.
1717
/// </summary>
18-
/// <param name="type">The value of the element's <code>type</code> attribute.</param>
18+
/// <param name="type">The value of the element's <c>type</c> attribute.</param>
1919
/// <param name="suffix">The suffix value.</param>
2020
/// <param name="valueAttribute">The name of the value attribute to be bound.</param>
2121
/// <param name="changeAttribute">The name of an attribute that will register an associated change event.</param>
@@ -46,7 +46,7 @@ public BindInputElementAttribute(string type, string suffix, string valueAttribu
4646
}
4747

4848
/// <summary>
49-
/// Gets the value of the element's <code>type</code> attribute.
49+
/// Gets the value of the element's <c>type</c> attribute.
5050
/// </summary>
5151
public string Type { get; }
5252

src/Http/Authentication.Abstractions/src/IAuthenticationRequestHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public interface IAuthenticationRequestHandler : IAuthenticationHandler
1313
/// <summary>
1414
/// Returns true if request processing should stop.
1515
/// </summary>
16-
/// <returns><code>true</code> if request processing should stop.</returns>
16+
/// <returns><see langword="true" /> if request processing should stop.</returns>
1717
Task<bool> HandleRequestAsync();
1818
}
1919

src/Http/Headers/src/HeaderUtilities.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ private static int AdvanceCacheDirectiveIndex(int current, string headerValue)
230230
/// any value originally supplied in result will be overwritten.
231231
/// </param>
232232
/// <returns>
233-
/// <code>true</code> if <paramref name="targetValue"/> is found and successfully parsed; otherwise,
234-
/// <code>false</code>.
233+
/// <see langword="true" /> if <paramref name="targetValue"/> is found and successfully parsed; otherwise,
234+
/// <see langword="false" />.
235235
/// </returns>
236236
// e.g. { "headerValue=10, targetHeaderValue=30" }
237237
public static bool TryParseSeconds(StringValues headerValues, string targetValue, out TimeSpan? value)
@@ -286,8 +286,8 @@ public static bool TryParseSeconds(StringValues headerValues, string targetValue
286286
/// The target cache control directives to look for.
287287
/// </param>
288288
/// <returns>
289-
/// <code>true</code> if <paramref name="targetDirectives"/> is contained in <paramref name="cacheControlDirectives"/>;
290-
/// otherwise, <code>false</code>.
289+
/// <see langword="true" /> if <paramref name="targetDirectives"/> is contained in <paramref name="cacheControlDirectives"/>;
290+
/// otherwise, <see langword="false" />.
291291
/// </returns>
292292
public static bool ContainsCacheDirective(StringValues cacheControlDirectives, string targetDirectives)
293293
{
@@ -367,7 +367,7 @@ private static unsafe bool TryParseNonNegativeInt64FromHeaderValue(int startInde
367367
/// greater than Int64.MaxValue. This parameter is passed uninitialized; any value originally supplied in
368368
/// result will be overwritten.
369369
/// </param>
370-
/// <returns><code>true</code> if parsing succeeded; otherwise, <code>false</code>.</returns>
370+
/// <returns><see langword="true" /> if parsing succeeded; otherwise, <see langword="false" />.</returns>
371371
public static unsafe bool TryParseNonNegativeInt32(StringSegment value, out int result)
372372
{
373373
if (string.IsNullOrEmpty(value.Buffer) || value.Length == 0)
@@ -418,7 +418,7 @@ public static unsafe bool TryParseNonNegativeInt32(StringSegment value, out int
418418
/// represents a number greater than Int64.MaxValue. This parameter is passed uninitialized; any value
419419
/// originally supplied in result will be overwritten.
420420
/// </param>
421-
/// <returns><code>true</code> if parsing succeeded; otherwise, <code>false</code>.</returns>
421+
/// <returns><see langword="true" /> if parsing succeeded; otherwise, <see langword="false" />.</returns>
422422
public static unsafe bool TryParseNonNegativeInt64(StringSegment value, out long result)
423423
{
424424
if (string.IsNullOrEmpty(value.Buffer) || value.Length == 0)

src/Http/Http.Abstractions/src/HostString.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ public static HostString FromUriComponent(Uri uri)
223223
/// "abc.example.com:443" but not "example.com:443".
224224
/// Matching is case insensitive.
225225
/// </remarks>
226-
/// <returns><code>true</code> if <paramref name="value"/> matches any of the patterns.</returns>
226+
/// <returns><see langword="true" /> if <paramref name="value"/> matches any of the patterns.</returns>
227227
public static bool MatchesAny(StringSegment value, IList<StringSegment> patterns)
228228
{
229229
if (value == null)
@@ -282,7 +282,7 @@ public static bool MatchesAny(StringSegment value, IList<StringSegment> patterns
282282
/// Compares the equality of the Value property, ignoring case.
283283
/// </summary>
284284
/// <param name="other">The <see cref="HostString"/> to compare against.</param>
285-
/// <returns><code>true</code> if they have the same value.</returns>
285+
/// <returns><see langword="true" /> if they have the same value.</returns>
286286
public bool Equals(HostString other)
287287
{
288288
if (!HasValue && !other.HasValue)
@@ -296,7 +296,7 @@ public bool Equals(HostString other)
296296
/// Compares against the given object only if it is a HostString.
297297
/// </summary>
298298
/// <param name="obj">The <see cref="object"/> to compare against.</param>
299-
/// <returns><code>true</code> if they have the same value.</returns>
299+
/// <returns><see langword="true" /> if they have the same value.</returns>
300300
public override bool Equals(object obj)
301301
{
302302
if (ReferenceEquals(null, obj))
@@ -320,7 +320,7 @@ public override int GetHashCode()
320320
/// </summary>
321321
/// <param name="left">The left parameter.</param>
322322
/// <param name="right">The right parameter.</param>
323-
/// <returns><code>true</code> if both <see cref="HostString"/>'s have the same value.</returns>
323+
/// <returns><see langword="true" /> if both <see cref="HostString"/>'s have the same value.</returns>
324324
public static bool operator ==(HostString left, HostString right)
325325
{
326326
return left.Equals(right);
@@ -331,7 +331,7 @@ public override int GetHashCode()
331331
/// </summary>
332332
/// <param name="left">The left parameter.</param>
333333
/// <param name="right">The right parameter.</param>
334-
/// <returns><code>true</code> if both <see cref="HostString"/>'s values are not equal.</returns>
334+
/// <returns><see langword="true" /> if both <see cref="HostString"/>'s values are not equal.</returns>
335335
public static bool operator !=(HostString left, HostString right)
336336
{
337337
return !left.Equals(right);

src/Http/Http.Extensions/src/RequestHeaders.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ public Uri Referer
282282
/// <summary>
283283
/// Gets the value of header with <paramref name="name"/>.
284284
/// </summary>
285-
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <code>public static bool TryParse(string, out T)</code>.</remarks>
285+
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <c>public static bool TryParse(string, out T)</c>.</remarks>
286286
/// <typeparam name="T">The type of the header.
287287
/// The given type must have a static TryParse method.</typeparam>
288288
/// <param name="name">The name of the header to retrieve.</param>
@@ -295,7 +295,7 @@ public T Get<T>(string name)
295295
/// <summary>
296296
/// Gets the values of header with <paramref name="name"/>.
297297
/// </summary>
298-
/// <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>
298+
/// <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>
299299
/// <typeparam name="T">The type of the header.
300300
/// The given type must have a static TryParseList method.</typeparam>
301301
/// <param name="name">The name of the header to retrieve.</param>

src/Http/Http.Extensions/src/ResponseHeaders.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ public IList<SetCookieHeaderValue> SetCookie
161161
/// <summary>
162162
/// Gets the value of header with <paramref name="name"/>.
163163
/// </summary>
164-
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <code>public static bool TryParse(string, out T)</code>.</remarks>
164+
/// <remarks><typeparamref name="T"/> must contain a TryParse method with the signature <c>public static bool TryParse(string, out T)</c>.</remarks>
165165
/// <typeparam name="T">The type of the header.
166166
/// The given type must have a static TryParse method.</typeparam>
167167
/// <param name="name">The name of the header to retrieve.</param>
@@ -174,7 +174,7 @@ public T Get<T>(string name)
174174
/// <summary>
175175
/// Gets the values of header with <paramref name="name"/>.
176176
/// </summary>
177-
/// <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>
177+
/// <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>
178178
/// <typeparam name="T">The type of the header.
179179
/// The given type must have a static TryParseList method.</typeparam>
180180
/// <param name="name">The name of the header to retrieve.</param>

src/Http/Routing/src/RouteConstraintBuilder.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ public IDictionary<string, IRouteConstraint> Build()
9090
/// <remarks>
9191
/// If the <paramref name="value"/> is a string, it will be converted to a <see cref="RegexRouteConstraint"/>.
9292
///
93-
/// For example, the string <code>Product[0-9]+</code> will be converted to the regular expression
94-
/// <code>^(Product[0-9]+)</code>. See <see cref="System.Text.RegularExpressions.Regex"/> for more details.
93+
/// For example, the string <c>Product[0-9]+</c> will be converted to the regular expression
94+
/// <c>^(Product[0-9]+)</c>. See <see cref="System.Text.RegularExpressions.Regex"/> for more details.
9595
/// </remarks>
9696
public void AddConstraint(string key, object value)
9797
{

src/Mvc/Mvc.Abstractions/src/ModelBinding/ModelStateDictionary.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public ModelStateDictionary(ModelStateDictionary dictionary)
8181
/// <see cref="ModelStateDictionary"/> tracks the number of model errors added by calls to
8282
/// <see cref="AddModelError(string, Exception, ModelMetadata)"/> or
8383
/// <see cref="TryAddModelError(string, Exception, ModelMetadata)"/>.
84-
/// Once the value of <code>MaxAllowedErrors - 1</code> is reached, if another attempt is made to add an error,
84+
/// Once the value of <c>MaxAllowedErrors - 1</c> is reached, if another attempt is made to add an error,
8585
/// the error message will be ignored and a <see cref="TooManyModelErrorsException"/> will be added.
8686
/// </para>
8787
/// <para>

src/Mvc/Mvc.Core/src/Controllers/ControllerFeatureProvider.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) .NET Foundation. All rights reserved.
1+
// Copyright (c) .NET Foundation. All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System;
@@ -37,7 +37,7 @@ public void PopulateFeature(
3737
/// Determines if a given <paramref name="typeInfo"/> is a controller.
3838
/// </summary>
3939
/// <param name="typeInfo">The <see cref="TypeInfo"/> candidate.</param>
40-
/// <returns><code>true</code> if the type is a controller; otherwise <code>false</code>.</returns>
40+
/// <returns><see langword="true" /> if the type is a controller; otherwise <see langword="false" />.</returns>
4141
protected virtual bool IsController(TypeInfo typeInfo)
4242
{
4343
if (!typeInfo.IsClass)

src/Mvc/Mvc.Core/src/Formatters/MediaTypeCollection.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ public void Insert(int index, MediaTypeHeaderValue item)
5050
/// Removes the first occurrence of a specific media type from the <see cref="MediaTypeCollection"/>.
5151
/// </summary>
5252
/// <param name="item"></param>
53-
/// <returns><code>true</code> if <paramref name="item"/> is successfully removed; otherwise, <code>false</code>.
54-
/// This method also returns <code>false</code> if <paramref name="item"/> was not found in the original
53+
/// <returns><see langword="true" /> if <paramref name="item"/> is successfully removed; otherwise, <see langword="false" />.
54+
/// This method also returns <see langword="false" /> if <paramref name="item"/> was not found in the original
5555
/// <see cref="MediaTypeCollection"/>.</returns>
5656
public bool Remove(MediaTypeHeaderValue item)
5757
{

src/Mvc/Mvc.Core/src/Routing/IRouteValueProvider.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ namespace Microsoft.AspNetCore.Mvc.Routing
2525
/// <see cref="ControllerActionDescriptor.ActionName"/>
2626
/// </para>
2727
/// <example>
28-
/// For an action like <code>MyApp.Controllers.HomeController.Index()</code>, in order to be selected, the
28+
/// For an action like <c>MyApp.Controllers.HomeController.Index()</c>, in order to be selected, the
2929
/// <see cref="RouteData.Values"/> must contain the values
3030
/// {
3131
/// "action": "Index",
@@ -39,20 +39,20 @@ namespace Microsoft.AspNetCore.Mvc.Routing
3939
/// <see cref="IRouteValueProvider"/>) or are considered 'outside' of areas by having the value <c>null</c>.
4040
/// </para>
4141
/// <example>
42-
/// Consider an application with two controllers, each with an <code>Index</code> action method:
43-
/// - <code>MyApp.Controllers.HomeController.Index()</code>
44-
/// - <code>MyApp.Areas.Blog.Controllers.HomeController.Index()</code>
45-
/// where <code>MyApp.Areas.Blog.Controllers.HomeController</code> has an area attribute
46-
/// <code>[Area("Blog")]</code>.
42+
/// Consider an application with two controllers, each with an <c>Index</c> action method:
43+
/// - <c>MyApp.Controllers.HomeController.Index()</c>
44+
/// - <c>MyApp.Areas.Blog.Controllers.HomeController.Index()</c>
45+
/// where <c>MyApp.Areas.Blog.Controllers.HomeController</c> has an area attribute
46+
/// <c>[Area("Blog")]</c>.
4747
///
4848
/// For <see cref="RouteData.Values"/> like:
4949
/// {
5050
/// "action": "Index",
5151
/// "controller": "Home"
5252
/// }
5353
///
54-
/// <code>MyApp.Controllers.HomeController.Index()</code> will be selected.
55-
/// <code>MyApp.Area.Blog.Controllers.HomeController.Index()</code> is not considered eligible because the
54+
/// <c>MyApp.Controllers.HomeController.Index()</c> will be selected.
55+
/// <c>MyApp.Area.Blog.Controllers.HomeController.Index()</c> is not considered eligible because the
5656
/// <see cref="RouteData.Values"/> does not contain the value 'Blog' for 'area'.
5757
///
5858
/// For <see cref="RouteData.Values"/> like:
@@ -62,9 +62,9 @@ namespace Microsoft.AspNetCore.Mvc.Routing
6262
/// "controller": "Home"
6363
/// }
6464
///
65-
/// <code>MyApp.Area.Blog.Controllers.HomeController.Index()</code> will be selected.
66-
/// <code>MyApp.Controllers.HomeController.Index()</code> is not considered eligible because the route values
67-
/// contain a value for 'area'. <code>MyApp.Controllers.HomeController.Index()</code> cannot match any value
65+
/// <c>MyApp.Area.Blog.Controllers.HomeController.Index()</c> will be selected.
66+
/// <c>MyApp.Controllers.HomeController.Index()</c> is not considered eligible because the route values
67+
/// contain a value for 'area'. <c>MyApp.Controllers.HomeController.Index()</c> cannot match any value
6868
/// for 'area' other than <c>null</c>.
6969
/// </example>
7070
/// </remarks>

src/Mvc/Mvc.Razor/src/Internal/RazorInjectAttribute.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor.Internal
88
/// <summary>
99
/// Specifies that the attributed property should be bound using request services.
1010
/// <para>
11-
/// This attribute is used as the backing attribute for the <code>@inject</code>
11+
/// This attribute is used as the backing attribute for the <c>@inject</c>
1212
/// Razor directive.
1313
/// </para>
1414
/// </summary>

src/Mvc/Mvc.Testing/src/WebApplicationFactoryContentRootAttribute.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) .NET Foundation. All rights reserved.
1+
// Copyright (c) .NET Foundation. All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System;
@@ -16,7 +16,7 @@ namespace Microsoft.AspNetCore.Mvc.Testing
1616
/// <see cref="Key"/> is equal to <c>TEntryPoint</c> <see cref="Assembly.FullName"/>,
1717
/// order them by <see cref="Priority"/> in ascending order.
1818
/// <see cref="WebApplicationFactory{TEntryPoint}"/> will check for the existence of the marker
19-
/// in <code>Path.Combine(<see cref="ContentRootPath"/>, Path.GetFileName(<see cref="ContentRootTest"/>))"</code>
19+
/// in <c>Path.Combine(<see cref="ContentRootPath"/>, Path.GetFileName(<see cref="ContentRootTest"/>))"</c>
2020
/// and if the file exists it will set the content root to <see cref="ContentRootPath"/>.
2121
/// </summary>
2222
[AttributeUsage(AttributeTargets.Assembly, Inherited = false, AllowMultiple = true)]
@@ -33,7 +33,7 @@ public sealed class WebApplicationFactoryContentRootAttribute : Attribute
3333
/// </param>
3434
/// <param name="contentRootPath">The path to the content root. This path can be either relative or absolute.
3535
/// In case the path is relative, the path will be combined with
36-
/// <code><see cref="Directory.GetCurrentDirectory()"/></code></param>
36+
/// <see cref="Directory.GetCurrentDirectory()"/></param>
3737
/// <param name="contentRootTest">
3838
/// A file that will be use as a marker to determine that the content root path for the given context is correct.
3939
/// </param>

0 commit comments

Comments
 (0)