From 93ded2b68a31fc9da643ac65955219e4f306ab82 Mon Sep 17 00:00:00 2001
From: transtrike <transtrike@gmail.com>
Date: Sat, 13 Mar 2021 11:44:01 +0200
Subject: XML Docs on all controllers

---
 .../Controllers/TechnologyController.cs            | 25 +++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

(limited to 'src/Web/DevHive.Web/Controllers/TechnologyController.cs')

diff --git a/src/Web/DevHive.Web/Controllers/TechnologyController.cs b/src/Web/DevHive.Web/Controllers/TechnologyController.cs
index ba3f04a..ecf2bd7 100644
--- a/src/Web/DevHive.Web/Controllers/TechnologyController.cs
+++ b/src/Web/DevHive.Web/Controllers/TechnologyController.cs
@@ -10,6 +10,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace DevHive.Web.Controllers
 {
+	/// <summary>
+	/// All endpoints for interacting with the technology layer
+	/// </summary>
 	[ApiController]
 	[Route("/api/[controller]")]
 	public class TechnologyController
@@ -27,7 +30,7 @@ namespace DevHive.Web.Controllers
 		/// Create a new technology, so users can have a choice. Admin only!
 		/// </summary>
 		/// <param name="createTechnologyWebModel">Data for the new technology</param>
-		/// <returns></returns>
+		/// <returns>The new technology's Id</returns>
 		[HttpPost]
 		[Authorize(Roles = "Admin")]
 		public async Task<IActionResult> Create([FromBody] CreateTechnologyWebModel createTechnologyWebModel)
@@ -41,6 +44,11 @@ namespace DevHive.Web.Controllers
 				new OkObjectResult(new { Id = id });
 		}
 
+		/// <summary>
+		/// Get technology's data by it's Id
+		/// </summary>
+		/// <param name="id">The technology's Id</param>
+		/// <returns>The technology's full data</returns>
 		[HttpGet]
 		[AllowAnonymous]
 		public async Task<IActionResult> GetById(Guid id)
@@ -51,6 +59,10 @@ namespace DevHive.Web.Controllers
 			return new OkObjectResult(readTechnologyWebModel);
 		}
 
+		/// <summary>
+		/// Get all technologies from our database
+		/// </summary>
+		/// <returns>All technologies</returns>
 		[HttpGet]
 		[Route("GetTechnologies")]
 		[Authorize(Roles = "User,Admin")]
@@ -62,6 +74,12 @@ namespace DevHive.Web.Controllers
 			return new OkObjectResult(languageWebModels);
 		}
 
+		/// <summary>
+		/// Alter a technology's parameters. Admin only!
+		/// </summary>
+		/// <param name="id">Technology's Id</param>
+		/// <param name="updateModel">The new parametars</param>
+		/// <returns>Ok result</returns>
 		[HttpPut]
 		[Authorize(Roles = "Admin")]
 		public async Task<IActionResult> Update(Guid id, [FromBody] UpdateTechnologyWebModel updateModel)
@@ -77,6 +95,11 @@ namespace DevHive.Web.Controllers
 			return new OkResult();
 		}
 
+		/// <summary>
+		/// Delete a etchnology from the database. Admin only!
+		/// </summary>
+		/// <param name="id">The technology's Id</param>
+		/// <returns>Ok result</returns>
 		[HttpDelete]
 		[Authorize(Roles = "Admin")]
 		public async Task<IActionResult> Delete(Guid id)
-- 
cgit v1.2.3