more Improved Comments in Controller

This commit is contained in:
Taha FADL
2020-07-19 13:09:48 +02:00
parent 79cc2dd740
commit a5f23bcd9a
7 changed files with 100 additions and 93 deletions

View File

@@ -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)
{