add xml remarks regarding dependencies (#348)

CarterCommunity · May 20, 2024 · a598d57 · a598d57
1 parent 6b4f683
commit a598d57
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/Carter/ICarterModule.cs b/src/Carter/ICarterModule.cs
@@ -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);
 }