Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add xml remarks regarding dependencies #348

Merged
merged 1 commit into from
May 20, 2024
Merged

add xml remarks regarding dependencies #348

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Carter/ICarterModule.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,13 @@ public CarterModule RequireRateLimiting(string policyName)
/// <summary>
/// An interface to define HTTP routes
/// </summary>
/// <remarks>Implementations of <see cref="ICarterModule"/> should not inject constructor dependencies. All dependencies should be supplied in the route <see cref="RequestDelegate"/></remarks>
public interface ICarterModule
{
/// <summary>
/// Invoked at startup to add routes to the HTTP pipeline
/// </summary>
/// <remarks>Implementations of <see cref="ICarterModule"/> should not inject constructor dependencies. All dependencies should be supplied in the route <see cref="RequestDelegate"/></remarks>
/// <param name="app">An instance of <see cref="IEndpointRouteBuilder"/></param>
void AddRoutes(IEndpointRouteBuilder app);
}
Loading