Skip to content

Commit fe9d7a8

Browse files
committed
Updated documentation for MapTopicRoute(IEndpointRouteBuilder)
Updated the documentation to include the actual pattern being implemented, so it's less obscured by the extension method. This is a best practice that Microsoft implements with many of their own extension methods, and which we should adopt. In addition, removed the reference back to the `MapTopicRoute(IRouteBuilder)` extension method, since it's now marked as deprecated.
1 parent 25419dd commit fe9d7a8

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

OnTopic.AspNetCore.Mvc/ServiceCollectionExtensions.cs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,10 @@ public static IRouteBuilder MapTopicRoute(
8686
| EXTENSION: MAP TOPIC ROUTE (IENDPOINTROUTEBUILDER)
8787
\-------------------------------------------------------------------------------------------------------------------------*/
8888
/// <summary>
89-
/// Adds an MVC route for handling OnTopic related requests, and maps it to the <see cref="TopicController"/> by default.
89+
/// Adds the <c>{rootTopic}/{**path}</c> endpoint route for a specific root topic, which enables that root to be mapped to
90+
/// specific topics via the <see cref="TopicRepositoryExtensions.Load(Repositories.ITopicRepository, RouteData)"/>
91+
/// extension method used by <see cref="TopicController"/>.
9092
/// </summary>
91-
/// <remarks>
92-
/// This is functionally identical to <see cref="MapTopicRoute(IRouteBuilder, String, String, String)"/>, except that it
93-
/// targets the <see cref="IEndpointRouteBuilder"/>, which is preferred in ASP.NET Core 3.
94-
/// </remarks>
9593
public static ControllerActionEndpointConventionBuilder MapTopicRoute(
9694
this IEndpointRouteBuilder routes,
9795
string rootTopic,

0 commit comments

Comments
 (0)