From a5f23bcd9a01f16e45de5054ac5a63bcaa78b1b2 Mon Sep 17 00:00:00 2001
From: Taha FADL <24903274+Taha5492@users.noreply.github.com>
Date: Sun, 19 Jul 2020 13:09:48 +0200
Subject: [PATCH] more Improved Comments in Controller

---
 .../Controllers/CategoriesController.cs       | 27 +++++++-------
 .../Controllers/ProjectsController.cs         | 25 ++++++-------
 .../Controllers/SprintsController.cs          | 29 +++++++--------
 .../Controllers/StatusController.cs           | 23 ++++++------
 ScrumTaskboard/Controllers/TasksController.cs | 31 ++++++++--------
 ScrumTaskboard/Controllers/UsersController.cs | 23 ++++++------
 .../Controllers/UserstoriesController.cs      | 35 ++++++++++---------
 7 files changed, 100 insertions(+), 93 deletions(-)

diff --git a/ScrumTaskboard/Controllers/CategoriesController.cs b/ScrumTaskboard/Controllers/CategoriesController.cs
index 8069d37..520b977 100644
--- a/ScrumTaskboard/Controllers/CategoriesController.cs
+++ b/ScrumTaskboard/Controllers/CategoriesController.cs
@@ -28,11 +28,12 @@ namespace ScrumTaskboard.Controllers
         // GET: api/category
         /// <summary>
         /// Retrieve all Categories in DB.
+        /// Result can be filtered using the Params.
         /// </summary>
-        /// <param name="title"></param>
-        /// <param name="projectid"></param>
-        /// <param name="color"></param>
-        /// <returns></returns>
+        /// <param name="title">string value</param>
+        /// <param name="projectid">ID of created Project</param>
+        /// <param name="color">string value</param>
+        /// <returns>JSON list of all matching Categories</returns>
 #nullable enable
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ScrumCategory>>> GetCategory([FromQuery]string? title, [FromQuery]int? projectid, [FromQuery] string? color)
@@ -61,8 +62,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Retrieve the Category by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">ID of searched Category</param>
+        /// <returns>JSON object</returns>
         [HttpGet("{id}")]
         public async Task<ActionResult<ScrumCategory>> GetCategory(int id)
         {
@@ -80,9 +81,9 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Update the Category identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <param name="category"></param>
-        /// <returns></returns>
+        /// <param name="id">To edit Category's ID</param>
+        /// <param name="category">modified Category</param>
+        /// <returns>???????</returns>
         [HttpPut("{id}")]
         public async Task<IActionResult> PutCategory(int id, ScrumCategory category)
         {
@@ -120,8 +121,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new Category.
         /// </summary>
-        /// <param name="category"></param>
-        /// <returns></returns>
+        /// <param name="category">???????</param>
+        /// <returns>???????</returns>
         [HttpPost]
         public async Task<ActionResult<ScrumUserstory>> PostCategory(ScrumCategory category)
         {
@@ -136,8 +137,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Delete a Category identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">To delete Category's ID</param>
+        /// <returns>???????</returns>
         [HttpDelete("{id}")]
         public async Task<ActionResult<ScrumCategory>> DeleteCategory(int id)
         {
diff --git a/ScrumTaskboard/Controllers/ProjectsController.cs b/ScrumTaskboard/Controllers/ProjectsController.cs
index 08c7f63..5cf06c7 100644
--- a/ScrumTaskboard/Controllers/ProjectsController.cs
+++ b/ScrumTaskboard/Controllers/ProjectsController.cs
@@ -28,10 +28,11 @@ namespace ScrumTaskboard.Controllers
         // GET: api/projects
         /// <summary>
         /// Retrieve all Projects in DB.
+        /// Result can be filtered using the Params.
         /// </summary>
-        /// <param name="title"></param>
-        /// <param name="isprivate"></param>
-        /// <returns></returns>
+        /// <param name="title">string value</param>
+        /// <param name="isprivate">boolean value</param>
+        /// <returns>JSON list of all matching Projects</returns>
 #nullable enable
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ScrumProject>>> GetProject([FromQuery]string? title, [FromQuery]bool? isprivate)
@@ -55,8 +56,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Retrieve the Project by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">ID of searched Project</param>
+        /// <returns>JSON object</returns>
         [HttpGet("{id}")]
         public async Task<ActionResult<ScrumProject>> GetProjects(int id)
         {
@@ -74,9 +75,9 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Update the Project identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <param name="projects"></param>
-        /// <returns></returns>
+        /// <param name="id">To edit Project's ID</param>
+        /// <param name="projects">modified Project</param>
+        /// <returns>???????</returns>
         [HttpPut("{id}")]
         public async Task<IActionResult> PutProject(int id, ScrumProject projects)
         {
@@ -114,8 +115,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new Project.
         /// </summary>
-        /// <param name="projects"></param>
-        /// <returns></returns>
+        /// <param name="projects">???????</param>
+        /// <returns>???????</returns>
         [HttpPost]
         public async Task<ActionResult<ScrumProject>> PostProject(ScrumProject projects)
         {
@@ -130,8 +131,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Delete a Project identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">To delete Project's ID</param>
+        /// <returns>???????</returns>
         [HttpDelete("{id}")]
         public async Task<ActionResult<ScrumProject>> DeleteProject(int id)
         {
diff --git a/ScrumTaskboard/Controllers/SprintsController.cs b/ScrumTaskboard/Controllers/SprintsController.cs
index 22af4be..4987218 100644
--- a/ScrumTaskboard/Controllers/SprintsController.cs
+++ b/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)
         {
diff --git a/ScrumTaskboard/Controllers/StatusController.cs b/ScrumTaskboard/Controllers/StatusController.cs
index 046f16e..75552cb 100644
--- a/ScrumTaskboard/Controllers/StatusController.cs
+++ b/ScrumTaskboard/Controllers/StatusController.cs
@@ -27,9 +27,10 @@ namespace ScrumTaskboard.Controllers
         // GET: api/status
         /// <summary>
         /// Retrieve all Status in DB.
+        /// Result can be filtered using the Params.
         /// </summary>
-        /// <param name="title"></param>
-        /// <returns></returns>
+        /// <param name="title">string value</param>
+        /// <returns>JSON list of all matching status</returns>
 #nullable enable
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ScrumStatus>>> GetStatus([FromQuery]string? title)
@@ -49,8 +50,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Retrieve the Status by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">ID of searched Status</param>
+        /// <returns>JSON object</returns>
         [HttpGet("{id}")]
         public async Task<ActionResult<ScrumStatus>> GetStatus(int id)
         {
@@ -68,9 +69,9 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Update the Status identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <param name="userstory"></param>
-        /// <returns></returns>
+        /// <param name="id">To edit Status' ID</param>
+        /// <param name="userstory">modified Userstory</param>
+        /// <returns>???????</returns>
         [HttpPut("{id}")]
         public async Task<IActionResult> PutStatus(int id, ScrumStatus userstory)
         {
@@ -108,8 +109,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new Status.
         /// </summary>
-        /// <param name="userstory"></param>
-        /// <returns></returns>
+        /// <param name="userstory">???????</param>
+        /// <returns>???????</returns>
         [HttpPost]
         public async Task<ActionResult<ScrumStatus>> PostTask(ScrumStatus userstory)
         {
@@ -124,8 +125,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new Status.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">To delete Status' ID</param>
+        /// <returns>???????</returns>
         [HttpDelete("{id}")]
         public async Task<ActionResult<ScrumStatus>> DeleteStatus(int id)
         {
diff --git a/ScrumTaskboard/Controllers/TasksController.cs b/ScrumTaskboard/Controllers/TasksController.cs
index 75e2084..29c79dd 100644
--- a/ScrumTaskboard/Controllers/TasksController.cs
+++ b/ScrumTaskboard/Controllers/TasksController.cs
@@ -28,14 +28,15 @@ namespace ScrumTaskboard.Controllers
         // GET: api/tasks
         /// <summary>
         /// Retrieve all Tasks in DB.
+        /// Result can be filtered using the Params.
         /// </summary>
-        /// <param name="title"></param>
-        /// <param name="userstoryid"></param>
-        /// <param name="statusid"></param>
-        /// <param name="assignedtoid"></param>
-        /// <param name="projectid"></param>
-        /// <param name="priority"></param>
-        /// <returns></returns>
+        /// <param name="title">string value</param>
+        /// <param name="userstoryid">ID of created Userstory</param>
+        /// <param name="statusid">ID of created Status</param>
+        /// <param name="assignedtoid">ID of the Assignedto</param>
+        /// <param name="projectid">ID of created Project</param>
+        /// <param name="priority">enum value</param>
+        /// <returns>JSON list of all matching Tasks</returns>
 #nullable enable
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ScrumTask>>> GetTasks([FromQuery]string? title, [FromQuery]int? userstoryid, [FromQuery]int? statusid, [FromQuery]int? assignedtoid, [FromQuery]int? projectid, [FromQuery]ScrumPrio? priority)
@@ -76,8 +77,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Retrieve the Task by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">ID of searched Task</param>
+        /// <returns>JSON object</returns>
         [HttpGet("{id}")]
         public async Task<ActionResult<ScrumTask>> GetTask(int id)
         {
@@ -95,8 +96,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Update the Task identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <param name="task"></param>
+        /// <param name="id">To edit Task's ID</param>
+        /// <param name="task">modified Task</param>
         /// <returns></returns>
         [HttpPut("{id}")]
         public async Task<IActionResult> PutTask(int id, ScrumTask task)
@@ -135,8 +136,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new Task.
         /// </summary>
-        /// <param name="task"></param>
-        /// <returns></returns>
+        /// <param name="task">???????</param>
+        /// <returns>???????</returns>
         [HttpPost]
         public async Task<ActionResult<ScrumTask>> PostTask(ScrumTask task)
         {
@@ -151,8 +152,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Delete a Task identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">To delete Task's ID</param>
+        /// <returns>???????</returns>
         [HttpDelete("{id}")]
         public async Task<ActionResult<ScrumTask>> DeleteTask(int id)
         {
diff --git a/ScrumTaskboard/Controllers/UsersController.cs b/ScrumTaskboard/Controllers/UsersController.cs
index 5c210a2..bbf5219 100644
--- a/ScrumTaskboard/Controllers/UsersController.cs
+++ b/ScrumTaskboard/Controllers/UsersController.cs
@@ -27,9 +27,10 @@ namespace ScrumTaskboard.Controllers
         // GET: api/sprint
         /// <summary>
         /// Retrieve all Users in DB.
+        /// Result can be filtered using the Params.
         /// </summary>
-        /// <param name="name"></param>
-        /// <returns></returns>
+        /// <param name="name">string value</param>
+        /// <returns>JSON list of all matching Users</returns>
 #nullable enable
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ScrumUser>>> GetUser([FromQuery]string? name)
@@ -48,8 +49,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Retrieve the User by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">ID of searched User</param>
+        /// <returns>JSON object</returns>
         [HttpGet("{id}")]
         public async Task<ActionResult<ScrumUser>> GetUser(int id)
         {
@@ -67,9 +68,9 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Update the User identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <param name="sprint"></param>
-        /// <returns></returns>
+        /// <param name="id">To edit User's ID</param>
+        /// <param name="sprint">modified Sprint</param>
+        /// <returns>???????</returns>
         [HttpPut("{id}")]
         public async Task<IActionResult> PutUser(int id, ScrumUser sprint)
         {
@@ -107,8 +108,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new User.
         /// </summary>
-        /// <param name="sprint"></param>
-        /// <returns></returns>
+        /// <param name="sprint">???????</param>
+        /// <returns>???????</returns>
         [HttpPost]
         public async Task<ActionResult<ScrumUser>> PostUser(ScrumUser sprint)
         {
@@ -123,8 +124,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Delete a User identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">To delete User's ID</param>
+        /// <returns>???????</returns>
         [HttpDelete("{id}")]
         public async Task<ActionResult<ScrumUser>> DeleteUser(int id)
         {
diff --git a/ScrumTaskboard/Controllers/UserstoriesController.cs b/ScrumTaskboard/Controllers/UserstoriesController.cs
index 16806f9..a826fdb 100644
--- a/ScrumTaskboard/Controllers/UserstoriesController.cs
+++ b/ScrumTaskboard/Controllers/UserstoriesController.cs
@@ -28,15 +28,16 @@ namespace ScrumTaskboard.Controllers
         // GET: api/userstories
         /// <summary>
         /// Retrieve all Userstories in DB.
+        /// Result can be filtered using the Params.
         /// </summary>
-        /// <param name="title"></param>
-        /// <param name="statusid"></param>
-        /// <param name="categoryid"></param>
-        /// <param name="createdbyid"></param>
-        /// <param name="projectid"></param>
-        /// <param name="sprintid"></param>
-        /// <param name="priority"></param>
-        /// <returns></returns>
+        /// <param name="title">string value</param>
+        /// <param name="statusid">ID of created Status</param>
+        /// <param name="categoryid">ID of created Category</param>
+        /// <param name="createdbyid">ID of the Author</param>
+        /// <param name="projectid">ID of created Project</param>
+        /// <param name="sprintid">ID of created Project</param>
+        /// <param name="priority">enum value</param>
+        /// <returns>JSON list of all matching Userstories</returns>
 #nullable enable
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ScrumUserstory>>> GetUserstory([FromQuery]string? title, [FromQuery]int? statusid, [FromQuery]int? categoryid, [FromQuery]int? createdbyid, [FromQuery]int? projectid, [FromQuery]int? sprintid, [FromQuery]ScrumPrio? priority)
@@ -81,8 +82,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Retrieve the Userstory by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">ID of searched Userstory</param>
+        /// <returns>JSON object</returns>
         [HttpGet("{id}")]
         public async Task<ActionResult<ScrumUserstory>> GetUserstory(int id)
         {
@@ -100,9 +101,9 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Update the Userstory identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <param name="userstory"></param>
-        /// <returns></returns>
+        /// <param name="id">To edit Userstory's ID</param>
+        /// <param name="userstory">modified Userstory</param>
+        /// <returns>???????</returns>
         [HttpPut("{id}")]
         public async Task<IActionResult> PutUserstory(int id, ScrumUserstory userstory)
         {
@@ -140,8 +141,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Create a new Userstory.
         /// </summary>
-        /// <param name="userstory"></param>
-        /// <returns></returns>
+        /// <param name="userstory">???????</param>
+        /// <returns>???????</returns>
         [HttpPost]
         public async Task<ActionResult<ScrumUserstory>> PostTask(ScrumUserstory userstory)
         {
@@ -156,8 +157,8 @@ namespace ScrumTaskboard.Controllers
         /// <summary>
         /// Delete a Userstory identified by it's ID.
         /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
+        /// <param name="id">To delete Userstory's ID</param>
+        /// <returns>???????</returns>
         [HttpDelete("{id}")]
         public async Task<ActionResult<ScrumUserstory>> DeleteUserstory(int id)
         {