Skip to content

Commit 1fb926a

Browse files
📝 Add docstrings to v10.0.0/launch
Docstrings generation was requested by @gimlichael. * #18 (comment) The following files were modified: * `src/Codebelt.Extensions.Asp.Versioning/ServiceCollectionExtensions.cs`
1 parent a6d3793 commit 1fb926a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/Codebelt.Extensions.Asp.Versioning/ServiceCollectionExtensions.cs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System;
1+
using System;
22
using Asp.Versioning;
33
using Cuemon;
44
using Microsoft.Extensions.DependencyInjection;
@@ -17,7 +17,11 @@ public static class ServiceCollectionExtensions
1717
/// <param name="services">The <see cref="IServiceCollection"/> to extend.</param>
1818
/// <param name="setup">The <see cref="RestfulApiVersioningOptions"/> that may be configured.</param>
1919
/// <returns>A reference to <paramref name="services" /> so that additional calls can be chained.</returns>
20-
/// <remarks>This is a convenient method to add API versioning to your ASP.NET Core WebApi. Call <c>AddApiVersioning</c>, <c>AddMvc</c> and <c>AddApiExplorer</c>. Configuration, which is optimized for RESTful APIs, are done through <paramref name="setup"/>.</remarks>
20+
/// <summary>
21+
/// Adds and configures RESTful API versioning, related MVC conventions, API Explorer grouping, and Problem Details handling to the service collection.
22+
/// </summary>
23+
/// <param name="setup">Optional configurator for RestfulApiVersioningOptions that controls default API version, valid Accept headers, parameter name, conventions, API version selector type, and Problem Details behavior.</param>
24+
/// <returns>The original IServiceCollection instance for chaining.</returns>
2125
public static IServiceCollection AddRestfulApiVersioning(this IServiceCollection services, Action<RestfulApiVersioningOptions> setup = null)
2226
{
2327
Validator.ThrowIfNull(services);
@@ -61,4 +65,4 @@ public static IServiceCollection AddRestfulApiVersioning(this IServiceCollection
6165
return services;
6266
}
6367
}
64-
}
68+
}

0 commit comments

Comments
 (0)