Skip to content

Commit ec7ce66

Browse files
sungam3rsungam3r
authored
Remove trailing whitespaces from xml comments (graphql-dotnet#3617)
1 parent f3fa7d5 commit ec7ce66

File tree

10 files changed

+54
-54
lines changed

10 files changed

+54
-54
lines changed

‎src/GraphQL/BoolBox.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
namespace GraphQL;
22

3-
/// <summary> Boolean values to avoid boxing. </summary>
3+
/// <summary>Boolean values to avoid boxing.</summary>
44
public static class BoolBox
55
{
66
/// <summary>
@@ -13,18 +13,18 @@ public static class BoolBox
1313
/// </summary>
1414
public static readonly object False = false;
1515

16-
/// <summary> This method avoids boxing boolean values. </summary>
17-
/// <param name="value"> Original boolean value. </param>
18-
/// <returns> Shared static boxed boolean value. </returns>
16+
/// <summary>This method avoids boxing boolean values.</summary>
17+
/// <param name="value">Original boolean value.</param>
18+
/// <returns>Shared static boxed boolean value.</returns>
1919
public static object Boxed(this bool value) => value switch
2020
{
2121
true => True,
2222
false => False,
2323
};
2424

25-
/// <summary> This method avoids boxing boolean values. </summary>
26-
/// <param name="value"> Original boolean value. </param>
27-
/// <returns> Shared static boxed boolean value or <see langword="null"/>. </returns>
25+
/// <summary>This method avoids boxing boolean values.</summary>
26+
/// <param name="value">Original boolean value.</param>
27+
/// <returns>Shared static boxed boolean value or <see langword="null"/>.</returns>
2828
public static object? Boxed(this bool? value) => value switch
2929
{
3030
true => True,

‎src/GraphQL/Extensions/AuthorizationExtensions.cs

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public static class AuthorizationExtensions
4040
/// Metadata provider. This can be an instance of <see cref="GraphType"/>,
4141
/// <see cref="FieldType"/>, <see cref="Schema"/> or others.
4242
/// </param>
43-
/// <returns> List of authorization policy names applied to this metadata provider. </returns>
43+
/// <returns>List of authorization policy names applied to this metadata provider.</returns>
4444
public static List<string>? GetPolicies(this IProvideMetadata provider) => provider.GetMetadata<List<string>>(POLICY_KEY);
4545

4646
/// <summary>
@@ -51,7 +51,7 @@ public static class AuthorizationExtensions
5151
/// Metadata provider. This can be an instance of <see cref="GraphType"/>,
5252
/// <see cref="FieldType"/>, <see cref="Schema"/> or others.
5353
/// </param>
54-
/// <returns> List of authorization role names applied to this metadata provider. </returns>
54+
/// <returns>List of authorization role names applied to this metadata provider.</returns>
5555
public static List<string>? GetRoles(this IProvideMetadata provider) => provider.GetMetadata<List<string>>(ROLE_KEY);
5656

5757
/// <summary>
@@ -78,7 +78,7 @@ public static TMetadataProvider AllowAnonymous<TMetadataProvider>(this TMetadata
7878
/// Metadata provider. This can be an instance of <see cref="GraphType"/>,
7979
/// <see cref="FieldType"/>, <see cref="Schema"/> or others.
8080
/// </param>
81-
/// <returns> <see langword="true"/> if any authorization policy is applied, otherwise <see langword="false"/>. </returns>
81+
/// <returns><see langword="true"/>if any authorization policy is applied, otherwise <see langword="false"/>.</returns>
8282
public static bool IsAuthorizationRequired(this IProvideMetadata provider)
8383
=> provider.GetMetadata(AUTHORIZE_KEY, false) || GetPolicies(provider)?.Count > 0 || GetRoles(provider)?.Count > 0;
8484

@@ -107,8 +107,8 @@ public static TMetadataProvider Authorize<TMetadataProvider>(this TMetadataProvi
107107
/// Metadata provider. This can be an instance of <see cref="GraphType"/>,
108108
/// <see cref="FieldType"/>, <see cref="Schema"/> or others.
109109
/// </param>
110-
/// <param name="policy"> Authorization policy name. </param>
111-
/// <returns> The reference to the specified <paramref name="provider"/>. </returns>
110+
/// <param name="policy">Authorization policy name.</param>
111+
/// <returns>The reference to the specified <paramref name="provider"/>.</returns>
112112
public static TMetadataProvider AuthorizeWithPolicy<TMetadataProvider>(this TMetadataProvider provider, string policy)
113113
where TMetadataProvider : IProvideMetadata
114114
{
@@ -137,8 +137,8 @@ public static TMetadataProvider AuthorizeWithPolicy<TMetadataProvider>(this TMet
137137
/// Metadata provider. This can be an instance of <see cref="GraphType"/>,
138138
/// <see cref="FieldType"/>, <see cref="Schema"/> or others.
139139
/// </param>
140-
/// <param name="roles"> Comma-separated list of authorization role name(s). </param>
141-
/// <returns> The reference to the specified <paramref name="provider"/>. </returns>
140+
/// <param name="roles">Comma-separated list of authorization role name(s).</param>
141+
/// <returns>The reference to the specified <paramref name="provider"/>.</returns>
142142
public static TMetadataProvider AuthorizeWithRoles<TMetadataProvider>(this TMetadataProvider provider, string roles)
143143
where TMetadataProvider : IProvideMetadata
144144
{
@@ -170,8 +170,8 @@ public static TMetadataProvider AuthorizeWithRoles<TMetadataProvider>(this TMeta
170170
/// Metadata provider. This can be an instance of <see cref="GraphType"/>,
171171
/// <see cref="FieldType"/>, <see cref="Schema"/> or others.
172172
/// </param>
173-
/// <param name="roles"> List of authorization role name(s). </param>
174-
/// <returns> The reference to the specified <paramref name="provider"/>. </returns>
173+
/// <param name="roles">List of authorization role name(s).</param>
174+
/// <returns>The reference to the specified <paramref name="provider"/>.</returns>
175175
public static TMetadataProvider AuthorizeWithRoles<TMetadataProvider>(this TMetadataProvider provider, params string[] roles)
176176
where TMetadataProvider : IProvideMetadata
177177
{
@@ -198,8 +198,8 @@ public static TMetadataProvider AuthorizeWithRoles<TMetadataProvider>(this TMeta
198198
/// <typeparam name="TSourceType"></typeparam>
199199
/// <typeparam name="TReturnType"></typeparam>
200200
/// <param name="builder"></param>
201-
/// <param name="policy"> Authorization policy name. </param>
202-
/// <returns> The reference to the specified <paramref name="builder"/>. </returns>
201+
/// <param name="policy">Authorization policy name.</param>
202+
/// <returns>The reference to the specified <paramref name="builder"/>.</returns>
203203
public static FieldBuilder<TSourceType, TReturnType> AuthorizeWithPolicy<TSourceType, TReturnType>(
204204
this FieldBuilder<TSourceType, TReturnType> builder, string policy)
205205
{
@@ -213,8 +213,8 @@ public static FieldBuilder<TSourceType, TReturnType> AuthorizeWithPolicy<TSource
213213
/// contains a role with the same name, then it will not be added twice.
214214
/// </summary>
215215
/// <param name="builder"></param>
216-
/// <param name="roles"> Comma-separated list of authorization role name(s). </param>
217-
/// <returns> The reference to the specified <paramref name="builder"/>. </returns>
216+
/// <param name="roles">Comma-separated list of authorization role name(s).</param>
217+
/// <returns>The reference to the specified <paramref name="builder"/>.</returns>
218218
public static FieldBuilder<TSourceType, TReturnType> AuthorizeWithRoles<TSourceType, TReturnType>(
219219
this FieldBuilder<TSourceType, TReturnType> builder, string roles)
220220
{
@@ -227,8 +227,8 @@ public static FieldBuilder<TSourceType, TReturnType> AuthorizeWithRoles<TSourceT
227227
/// contains a role with the same name, then it will not be added twice.
228228
/// </summary>
229229
/// <param name="builder"></param>
230-
/// <param name="roles"> List of authorization role name(s). </param>
231-
/// <returns> The reference to the specified <paramref name="builder"/>. </returns>
230+
/// <param name="roles">List of authorization role name(s).</param>
231+
/// <returns>The reference to the specified <paramref name="builder"/>.</returns>
232232
public static FieldBuilder<TSourceType, TReturnType> AuthorizeWithRoles<TSourceType, TReturnType>(
233233
this FieldBuilder<TSourceType, TReturnType> builder, params string[] roles)
234234
{
@@ -258,8 +258,8 @@ public static FieldBuilder<TSourceType, TReturnType> AllowAnonymous<TSourceType,
258258
/// </summary>
259259
/// <typeparam name="TSourceType"></typeparam>
260260
/// <param name="builder"></param>
261-
/// <param name="policy"> Authorization policy name. </param>
262-
/// <returns> The reference to the specified <paramref name="builder"/>. </returns>
261+
/// <param name="policy">Authorization policy name.</param>
262+
/// <returns>The reference to the specified <paramref name="builder"/>.</returns>
263263
public static ConnectionBuilder<TSourceType> AuthorizeWithPolicy<TSourceType>(
264264
this ConnectionBuilder<TSourceType> builder, string policy)
265265
{
@@ -273,8 +273,8 @@ public static ConnectionBuilder<TSourceType> AuthorizeWithPolicy<TSourceType>(
273273
/// contains a role with the same name, then it will not be added twice.
274274
/// </summary>
275275
/// <param name="builder"></param>
276-
/// <param name="roles"> Comma-separated list of authorization role name(s). </param>
277-
/// <returns> The reference to the specified <paramref name="builder"/>. </returns>
276+
/// <param name="roles">Comma-separated list of authorization role name(s).</param>
277+
/// <returns>The reference to the specified <paramref name="builder"/>.</returns>
278278
public static ConnectionBuilder<TSourceType> AuthorizeWithRoles<TSourceType>(
279279
this ConnectionBuilder<TSourceType> builder, string roles)
280280
{
@@ -287,8 +287,8 @@ public static ConnectionBuilder<TSourceType> AuthorizeWithRoles<TSourceType>(
287287
/// contains a role with the same name, then it will not be added twice.
288288
/// </summary>
289289
/// <param name="builder"></param>
290-
/// <param name="roles"> List of authorization role name(s). </param>
291-
/// <returns> The reference to the specified <paramref name="builder"/>. </returns>
290+
/// <param name="roles">List of authorization role name(s).</param>
291+
/// <returns>The reference to the specified <paramref name="builder"/>.</returns>
292292
public static ConnectionBuilder<TSourceType> AuthorizeWithRoles<TSourceType>(
293293
this ConnectionBuilder<TSourceType> builder, params string[] roles)
294294
{

‎src/GraphQL/Extensions/GraphQLExtensions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ public static Type GetNamedType(this Type type)
177177
/// </summary>
178178
/// <param name="iface">The interface graph type.</param>
179179
/// <param name="type">The object graph type to verify it against.</param>
180-
/// <param name="throwError"> Set to <see langword="true"/> to generate an error if the type does not match the interface. </param>
180+
/// <param name="throwError">Set to <see langword="true"/> to generate an error if the type does not match the interface.</param>
181181
public static bool IsValidInterfaceFor(this IInterfaceGraphType iface, IObjectGraphType type, bool throwError = true)
182182
{
183183
foreach (var field in iface.Fields)
@@ -253,11 +253,11 @@ public static string NameOf<TSourceType, TProperty>(this Expression<Func<TSource
253253
/// <summary>
254254
/// Adds a key-value metadata pair to the specified provider.
255255
/// </summary>
256-
/// <typeparam name="TMetadataProvider"> The type of metadata provider. Generics are used here to let compiler infer the returning type to allow methods chaining. </typeparam>
257-
/// <param name="provider"> Metadata provider which must implement <see cref="IProvideMetadata"/> interface. </param>
258-
/// <param name="key"> String key. </param>
259-
/// <param name="value"> Arbitrary value. </param>
260-
/// <returns> The reference to the specified <paramref name="provider"/>. </returns>
256+
/// <typeparam name="TMetadataProvider">The type of metadata provider. Generics are used here to let compiler infer the returning type to allow methods chaining.</typeparam>
257+
/// <param name="provider">Metadata provider which must implement <see cref="IProvideMetadata"/> interface.</param>
258+
/// <param name="key">String key.</param>
259+
/// <param name="value">Arbitrary value.</param>
260+
/// <returns>The reference to the specified <paramref name="provider"/>.</returns>
261261
public static TMetadataProvider WithMetadata<TMetadataProvider>(this TMetadataProvider provider, string key, object? value)
262262
where TMetadataProvider : IProvideMetadata
263263
{

‎src/GraphQL/Introspection/ISchemaComparer.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ public interface ISchemaComparer
1717
/// Returns a comparer for fields withing enclosing type.
1818
/// If this returns <see langword="null"/> then the original field ordering is preserved.
1919
/// </summary>
20-
/// <param name="parent"> Parent type to which the fields belong. </param>
20+
/// <param name="parent">Parent type to which the fields belong.</param>
2121
IComparer<IFieldType>? FieldComparer(IGraphType parent);
2222

2323
/// <summary>
2424
/// Returns a comparer for field arguments.
2525
/// If this returns <see langword="null"/> then the original argument ordering is preserved.
2626
/// </summary>
27-
/// <param name="field"> The field to which the arguments belong. </param>
27+
/// <param name="field">The field to which the arguments belong.</param>
2828
IComparer<QueryArgument>? ArgumentComparer(IFieldType field);
2929

3030
/// <summary>
3131
/// Returns a comparer for enum values.
3232
/// If this returns <see langword="null"/> then the original enum value ordering is preserved.
3333
/// </summary>
34-
/// <param name="parent"> The enumeration to which the enum values belong. </param>
34+
/// <param name="parent">The enumeration to which the enum values belong.</param>
3535
IComparer<EnumValueDefinition>? EnumValueComparer(EnumerationGraphType parent);
3636

3737
/// <summary>

‎src/GraphQL/Resolvers/NameFieldResolver.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ private NameFieldResolver() { }
5757
/// 3. Then result is converted again to the object and returned from the method.
5858
/// </para>
5959
/// </summary>
60-
/// <param name="target"> The type from which you want to get the value. </param>
61-
/// <param name="name"> Property/method name. </param>
62-
/// <returns> Compiled field resolver. </returns>
60+
/// <param name="target">The type from which you want to get the value.</param>
61+
/// <param name="name">Property/method name.</param>
62+
/// <returns>Compiled field resolver.</returns>
6363
private static IFieldResolver CreateResolver(Type target, string name)
6464
{
6565
var param = Expression.Parameter(typeof(IResolveFieldContext), "context");

‎src/GraphQL/Types/Composite/AutoRegisteringInputObjectGraphType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public AutoRegisteringInputObjectGraphType() : this(null) { }
2323
/// <summary>
2424
/// Creates a GraphQL type from <typeparamref name="TSourceType"/> by specifying fields to exclude from registration.
2525
/// </summary>
26-
/// <param name="excludedProperties"> Expressions for excluding fields, for example 'o => o.Age'. </param>
26+
/// <param name="excludedProperties">Expressions for excluding fields, for example 'o => o.Age'.</param>
2727
public AutoRegisteringInputObjectGraphType(params Expression<Func<TSourceType, object?>>[]? excludedProperties)
2828
{
2929
_excludedProperties = excludedProperties;

‎src/GraphQL/Types/Composite/AutoRegisteringInterfaceGraphType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public AutoRegisteringInterfaceGraphType() : this(null) { }
2222
/// <summary>
2323
/// Creates a GraphQL type from <typeparamref name="TSourceType"/> by specifying fields to exclude from registration.
2424
/// </summary>
25-
/// <param name="excludedProperties"> Expressions for excluding fields, for example 'o => o.Age'. </param>
25+
/// <param name="excludedProperties">Expressions for excluding fields, for example 'o => o.Age'.</param>
2626
public AutoRegisteringInterfaceGraphType(params Expression<Func<TSourceType, object?>>[]? excludedProperties)
2727
{
2828
_excludedProperties = excludedProperties;

‎src/GraphQL/Types/Composite/AutoRegisteringObjectGraphType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public AutoRegisteringObjectGraphType() : this(null) { }
2222
/// <summary>
2323
/// Creates a GraphQL type from <typeparamref name="TSourceType"/> by specifying fields to exclude from registration.
2424
/// </summary>
25-
/// <param name="excludedProperties"> Expressions for excluding fields, for example 'o => o.Age'. </param>
25+
/// <param name="excludedProperties">Expressions for excluding fields, for example 'o => o.Age'.</param>
2626
public AutoRegisteringObjectGraphType(params Expression<Func<TSourceType, object?>>[]? excludedProperties)
2727
{
2828
_excludedProperties = excludedProperties;

‎src/GraphQL/Types/IProvideMetadata.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,26 @@ public interface IProvideMetadata
1515
/// <summary>
1616
/// Gets a value by a given key. If there is no value for the given key, returns <paramref name="defaultValue"/>.
1717
/// </summary>
18-
/// <typeparam name="TType"> Type of the value. </typeparam>
19-
/// <param name="key"> String key. </param>
20-
/// <param name="defaultValue"> It is used if there is no value for the given key. </param>
21-
/// <returns> Value of the specified type. </returns>
18+
/// <typeparam name="TType">Type of the value.</typeparam>
19+
/// <param name="key">String key.</param>
20+
/// <param name="defaultValue">It is used if there is no value for the given key.</param>
21+
/// <returns>Value of the specified type.</returns>
2222
TType GetMetadata<TType>(string key, TType defaultValue = default!);
2323

2424
/// <summary>
2525
/// Gets a value by a given key. If there is no value for the given key, returns value obtained from <paramref name="defaultValueFactory"/>.
2626
/// </summary>
27-
/// <typeparam name="TType"> Type of the value. </typeparam>
28-
/// <param name="key"> String key. </param>
29-
/// <param name="defaultValueFactory"> It is used if there is no value for the given key. </param>
30-
/// <returns> Value of the specified type. </returns>
27+
/// <typeparam name="TType">Type of the value.</typeparam>
28+
/// <param name="key">String key.</param>
29+
/// <param name="defaultValueFactory">It is used if there is no value for the given key.</param>
30+
/// <returns>Value of the specified type.</returns>
3131
TType GetMetadata<TType>(string key, Func<TType> defaultValueFactory);
3232

3333
/// <summary>
3434
/// Indicates whether there is meta information with the given key.
3535
/// </summary>
36-
/// <param name="key"> String key. </param>
37-
/// <returns> <see langword="true"/> if value for such key exists, otherwise <see langword="false"/>. </returns>
36+
/// <param name="key">String key.</param>
37+
/// <returns><see langword="true"/> if value for such key exists, otherwise <see langword="false"/>.</returns>
3838
bool HasMetadata(string key);
3939
}
4040
}

‎src/GraphQL/Types/Scalars/Enumeration/EnumerationGraphType.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ public override GraphQLValue ToAST(object? value)
117117
/// Supports <see cref="DescriptionAttribute"/> and <see cref="ObsoleteAttribute"/>.
118118
/// Also it can get descriptions for enum fields from the XML comments.
119119
/// </summary>
120-
/// <typeparam name="TEnum"> The enum to take values from. </typeparam>
120+
/// <typeparam name="TEnum">The enum to take values from.</typeparam>
121121
public class EnumerationGraphType<TEnum> : EnumerationGraphType
122122
where TEnum : Enum
123123
{

0 commit comments

Comments
 (0)