more Improved Comments in Controller

ScrumTaskboard/Controllers/SprintsController.cs

@@ -28,12 +28,13 @@ namespace ScrumTaskboard.Controllers
         // GET: api/sprint
         /// <summary>
         /// Retrieve all Sprints in DB.
+        /// Result can be filtered using the Params.
         /// </summary>
-        /// <param name="title"></param>
-        /// <param name="projectid"></param>
-        /// <param name="startDate"></param>
-        /// <param name="endDate"></param>
-        /// <returns></returns>
+        /// <param name="title">string value</param>
+        /// <param name="projectid">ID of created Project</param>
+        /// <param name="startDate">DateTime value</param>
+        /// <param name="endDate">DateTime value</param>
+        /// <returns>JSON list of all matching Sprints</returns>
 #nullable enable
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ScrumSprint>>> GetSprint([FromQuery]string? title, [FromQuery]int? projectid, [FromQuery]DateTime? startDate, [FromQuery]DateTime? endDate)
@@ -65,8 +66,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Retrieve the Sprint by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">ID of searched Sprint</param>
+        /// <returns>JSON object</returns>
         [HttpGet("{id}")]
         public async Task<ActionResult<ScrumSprint>> GetSprint(int id)
         {
@@ -84,9 +85,9 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Update the Sprint identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <param name="sprint"></param>
-        /// <returns></returns>
+        /// <param name="id">To edit Sprint's ID</param>
+        /// <param name="sprint">modified Sprint</param>
+        /// <returns>???????</returns>
         [HttpPut("{id}")]
         public async Task<IActionResult> PutSprint(int id, ScrumSprint sprint)
         {
@@ -124,8 +125,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new Sprint.
         /// </summary>
-        /// <param name="sprint"></param>
-        /// <returns></returns>
+        /// <param name="sprint">???????</param>
+        /// <returns>???????</returns>
         [HttpPost]
         public async Task<ActionResult<ScrumSprint>> PostSprint(ScrumSprint sprint)
         {
@@ -140,8 +141,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Delete a Sprint identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">To delete Sprint's ID</param>
+        /// <returns>???????</returns>
         [HttpDelete("{id}")]
         public async Task<ActionResult<ScrumSprint>> DeleteSprint(int id)
         {