Skip to content

Commit c986ad6

Browse files
authored
Bring back docstring fixes
1 parent ae7b22f commit c986ad6

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

src/Http/Http.Extensions/src/EndpointDescriptionAttribute.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ namespace Microsoft.AspNetCore.Http;
1111
/// <remarks>
1212
/// The OpenAPI specification supports a description attribute on operations and parameters that
1313
/// can be used to annotate endpoints with detailed, multiline descriptors of their behavior.
14-
/// behavior.
1514
/// </remarks>
1615
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Delegate, Inherited = false, AllowMultiple = false)]
1716
public sealed class EndpointDescriptionAttribute : Attribute, IEndpointDescriptionMetadata

src/Http/Routing/src/Builder/OpenApiRouteHandlerBuilderExtensions.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class OpenApiRouteHandlerBuilderExtensions
1717
private static readonly ExcludeFromDescriptionAttribute _excludeFromDescriptionMetadataAttribute = new();
1818

1919
/// <summary>
20-
/// Adds the <see cref="IExcludeFromDescriptionMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
20+
/// Adds the <see cref="IExcludeFromDescriptionMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
2121
/// produced by <paramref name="builder"/>.
2222
/// </summary>
2323
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
@@ -30,7 +30,7 @@ public static RouteHandlerBuilder ExcludeFromDescription(this RouteHandlerBuilde
3030
}
3131

3232
/// <summary>
33-
/// Adds an <see cref="IProducesResponseTypeMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
33+
/// Adds an <see cref="IProducesResponseTypeMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
3434
/// produced by <paramref name="builder"/>.
3535
/// </summary>
3636
/// <typeparam name="TResponse">The type of the response.</typeparam>
@@ -50,7 +50,7 @@ public static RouteHandlerBuilder Produces<TResponse>(this RouteHandlerBuilder b
5050
}
5151

5252
/// <summary>
53-
/// Adds an <see cref="IProducesResponseTypeMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
53+
/// Adds an <see cref="IProducesResponseTypeMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
5454
/// produced by <paramref name="builder"/>.
5555
/// </summary>
5656
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
@@ -85,7 +85,7 @@ public static RouteHandlerBuilder Produces(this RouteHandlerBuilder builder,
8585

8686
/// <summary>
8787
/// Adds an <see cref="IProducesResponseTypeMetadata"/> with a <see cref="ProblemDetails"/> type
88-
/// to <see cref="EndpointBuilder.Metadata"/> for all builders produced by <paramref name="builder"/>.
88+
/// to <see cref="EndpointBuilder.Metadata"/> for all endpoints produced by <paramref name="builder"/>.
8989
/// </summary>
9090
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
9191
/// <param name="statusCode">The response status code.</param>
@@ -105,7 +105,7 @@ public static RouteHandlerBuilder ProducesProblem(this RouteHandlerBuilder build
105105

106106
/// <summary>
107107
/// Adds an <see cref="IProducesResponseTypeMetadata"/> with a <see cref="HttpValidationProblemDetails"/> type
108-
/// to <see cref="EndpointBuilder.Metadata"/> for all builders produced by <paramref name="builder"/>.
108+
/// to <see cref="EndpointBuilder.Metadata"/> for all endpoints produced by <paramref name="builder"/>.
109109
/// </summary>
110110
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
111111
/// <param name="statusCode">The response status code. Defaults to <see cref="StatusCodes.Status400BadRequest"/>.</param>
@@ -124,7 +124,7 @@ public static RouteHandlerBuilder ProducesValidationProblem(this RouteHandlerBui
124124
}
125125

126126
/// <summary>
127-
/// Adds the <see cref="ITagsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
127+
/// Adds the <see cref="ITagsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
128128
/// produced by <paramref name="builder"/>.
129129
/// </summary>
130130
/// <remarks>
@@ -142,7 +142,7 @@ public static RouteHandlerBuilder WithTags(this RouteHandlerBuilder builder, par
142142
}
143143

144144
/// <summary>
145-
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
145+
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
146146
/// produced by <paramref name="builder"/>.
147147
/// </summary>
148148
/// <typeparam name="TRequest">The type of the request body.</typeparam>
@@ -159,7 +159,7 @@ public static RouteHandlerBuilder Accepts<TRequest>(this RouteHandlerBuilder bui
159159
}
160160

161161
/// <summary>
162-
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
162+
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
163163
/// produced by <paramref name="builder"/>.
164164
/// </summary>
165165
/// <typeparam name="TRequest">The type of the request body.</typeparam>
@@ -177,7 +177,7 @@ public static RouteHandlerBuilder Accepts<TRequest>(this RouteHandlerBuilder bui
177177
}
178178

179179
/// <summary>
180-
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
180+
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
181181
/// produced by <paramref name="builder"/>.
182182
/// </summary>
183183
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
@@ -193,7 +193,7 @@ public static RouteHandlerBuilder Accepts(this RouteHandlerBuilder builder,
193193
}
194194

195195
/// <summary>
196-
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
196+
/// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
197197
/// produced by <paramref name="builder"/>.
198198
/// </summary>
199199
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
@@ -210,7 +210,7 @@ public static RouteHandlerBuilder Accepts(this RouteHandlerBuilder builder,
210210
}
211211

212212
/// <summary>
213-
/// Adds <see cref="IEndpointDescriptionMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
213+
/// Adds <see cref="IEndpointDescriptionMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
214214
/// produced by <paramref name="builder"/>.
215215
/// </summary>
216216
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
@@ -223,11 +223,11 @@ public static RouteHandlerBuilder WithDescription(this RouteHandlerBuilder build
223223
}
224224

225225
/// <summary>
226-
/// Adds <see cref="IEndpointSummaryMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
226+
/// Adds <see cref="IEndpointSummaryMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all endpoints
227227
/// produced by <paramref name="builder"/>.
228228
/// </summary>
229229
/// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
230-
/// <param name="summary">A string representation a brief description of the endpoint.</param>
230+
/// <param name="summary">A string representing a brief description of the endpoint.</param>
231231
/// <returns>A <see cref="RouteHandlerBuilder"/> that can be used to further customize the endpoint.</returns>
232232
public static RouteHandlerBuilder WithSummary(this RouteHandlerBuilder builder, string summary)
233233
{

0 commit comments

Comments
 (0)