Add missing documentation

MarcelGosselin · May 25, 2020 · 2dde067 · 2dde067
1 parent 92710bf
commit 2dde067
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/AspNetCore.TypedActionResults/ControllerBase.cs b/src/AspNetCore.TypedActionResults/ControllerBase.cs
@@ -4,6 +4,11 @@
 
 namespace AspNetCore.TypedActionResults
 {
+ /// <summary>
+ /// Defines a base controller with generic overrides of response-creating methods
+ /// that will ensure that a method with a return type of <c>Task&lt;ActionResult&lt;MyType&gt;&gt;</c>
+ /// will only compile if you return a response of type <c>MyType</c>.
+ /// </summary>
  public class ControllerBase
  : Microsoft.AspNetCore.Mvc.ControllerBase
  {