Skip to content

Commit a9381ab

Browse files
authored
Fix documentation comment code tags (#9572)
1 parent e183d9e commit a9381ab

7 files changed

Lines changed: 10 additions & 8 deletions

File tree

.editorconfig

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,8 @@ dotnet_diagnostic.RCS1214.severity = warning
319319
dotnet_diagnostic.RCS1217.severity = warning
320320
# Unused element in a documentation comment.
321321
dotnet_diagnostic.RCS1228.severity = warning
322+
# Fix documentation comment tag.
323+
dotnet_diagnostic.RCS1247.severity = warning
322324
# Unnecessary null-forgiving operator.
323325
dotnet_diagnostic.RCS1249.severity = warning
324326
# Remove unnecessary braces.

src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/Policy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
namespace HotChocolate.ApolloFederation.Types;
22

33
/// <summary>
4-
/// Scalar <code>Policy</code> representation.
4+
/// Scalar <c>Policy</c> representation.
55
/// </summary>
66
public readonly record struct Policy
77
{

src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/PolicyType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace HotChocolate.ApolloFederation.Types;
88

99
/// <summary>
10-
/// The <code>Policy</code> scalar representing an authorization policy. Serializes as a string.
10+
/// The <c>Policy</c> scalar representing an authorization policy. Serializes as a string.
1111
/// </summary>
1212
public sealed class PolicyType : ScalarType<Policy, StringValueNode>
1313
{

src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/Scope.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
namespace HotChocolate.ApolloFederation.Types;
22

33
/// <summary>
4-
/// Scalar <code>Scope</code> representation.
4+
/// Scalar <c>Scope</c> representation.
55
/// </summary>
66
public readonly record struct Scope
77
{

src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/ScopeType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace HotChocolate.ApolloFederation.Types;
88

99
/// <summary>
10-
/// The <code>Scope</code> scalar representing a JWT scope. Serializes as a string.
10+
/// The <c>Scope</c> scalar representing a JWT scope. Serializes as a string.
1111
/// </summary>
1212
public sealed class ScopeType : ScalarType<Scope, StringValueNode>
1313
{

src/HotChocolate/Core/src/Subscriptions.Nats/DependencyInjection/NatsPubSubExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public static class NatsPubSubExtensions
1414
{
1515
/// <summary>
1616
/// Adds support for using NATS as a subscription provider.
17-
/// Ensure you have configured the NATS client using <code>AddNatsClient(...)</code>
17+
/// Ensure you have configured the NATS client using <c>AddNatsClient(...)</c>
1818
/// before calling this method.
1919
/// </summary>
2020
/// <param name="builder">

src/HotChocolate/Core/src/Types.Mutations/MutationConventionOptions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public struct MutationConventionOptions
1010
/// <summary>
1111
/// Specifies a name pattern for the input type name of a mutation.
1212
/// The pattern is specified like the following:
13-
/// <code>"{MutationName}Input"</code>
13+
/// <c>"{MutationName}Input"</c>
1414
///
1515
/// <code>
1616
/// type Mutation {
@@ -43,7 +43,7 @@ public struct MutationConventionOptions
4343
/// <summary>
4444
/// Specifies a name pattern for the payload type name of a mutation.
4545
/// The pattern is specified like the following:
46-
/// <code>"{MutationName}Payload"</code>
46+
/// <c>"{MutationName}Payload"</c>
4747
///
4848
/// <code>
4949
/// type Mutation {
@@ -61,7 +61,7 @@ public struct MutationConventionOptions
6161
/// <summary>
6262
/// Specifies a name pattern for the error union type name of a mutation.
6363
/// The pattern is specified like the following:
64-
/// <code>"{MutationName}Error"</code>
64+
/// <c>"{MutationName}Error"</c>
6565
///
6666
/// <code>
6767
/// type Mutation {

0 commit comments

Comments
 (0)