From c071eeca829a18941fc29f4e4eb8b8f93a65b5c4 Mon Sep 17 00:00:00 2001
From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>
Date: Mon, 3 Jul 2023 23:16:42 +0300
Subject: docs: refactor docs

Former-commit-id: 3f3833af352d8758ca509a4fe3badedd5250b1ba
---
 backend/controllers/modController.go | 54 ++++++++++++++++++------------------
 1 file changed, 27 insertions(+), 27 deletions(-)

(limited to 'backend/controllers/modController.go')

diff --git a/backend/controllers/modController.go b/backend/controllers/modController.go
index f1874f7..d6dc4d4 100644
--- a/backend/controllers/modController.go
+++ b/backend/controllers/modController.go
@@ -11,15 +11,15 @@ import (
 
 // POST Map Summary
 //
-//	@Summary	Create map summary with specified map id.
-//	@Tags		maps
-//	@Produce	json
-//	@Param		Authorization	header		string							true	"JWT Token"
-//	@Param		id				path		int								true	"Map ID"
-//	@Param		request			body		models.CreateMapSummaryRequest	true	"Body"
-//	@Success	200				{object}	models.Response{data=models.CreateMapSummaryRequest}
-//	@Failure	400				{object}	models.Response
-//	@Router		/maps/{id}/summary [post]
+//	@Description	Create map summary with specified map id.
+//	@Tags			maps
+//	@Produce		json
+//	@Param			Authorization	header		string							true	"JWT Token"
+//	@Param			id				path		int								true	"Map ID"
+//	@Param			request			body		models.CreateMapSummaryRequest	true	"Body"
+//	@Success		200				{object}	models.Response{data=models.CreateMapSummaryRequest}
+//	@Failure		400				{object}	models.Response
+//	@Router			/maps/{id}/summary [post]
 func CreateMapSummary(c *gin.Context) {
 	// Check if user exists
 	user, exists := c.Get("user")
@@ -97,15 +97,15 @@ func CreateMapSummary(c *gin.Context) {
 
 // PUT Map Summary
 //
-//	@Summary	Edit map summary with specified map id.
-//	@Tags		maps
-//	@Produce	json
-//	@Param		Authorization	header		string							true	"JWT Token"
-//	@Param		id				path		int								true	"Map ID"
-//	@Param		request			body		models.EditMapSummaryRequest	true	"Body"
-//	@Success	200				{object}	models.Response{data=models.EditMapSummaryRequest}
-//	@Failure	400				{object}	models.Response
-//	@Router		/maps/{id}/summary [put]
+//	@Description	Edit map summary with specified map id.
+//	@Tags			maps
+//	@Produce		json
+//	@Param			Authorization	header		string							true	"JWT Token"
+//	@Param			id				path		int								true	"Map ID"
+//	@Param			request			body		models.EditMapSummaryRequest	true	"Body"
+//	@Success		200				{object}	models.Response{data=models.EditMapSummaryRequest}
+//	@Failure		400				{object}	models.Response
+//	@Router			/maps/{id}/summary [put]
 func EditMapSummary(c *gin.Context) {
 	// Check if user exists
 	user, exists := c.Get("user")
@@ -180,15 +180,15 @@ func EditMapSummary(c *gin.Context) {
 
 // DELETE Map Summary
 //
-//	@Summary	Delete map summary with specified map id.
-//	@Tags		maps
-//	@Produce	json
-//	@Param		Authorization	header		string							true	"JWT Token"
-//	@Param		id				path		int								true	"Map ID"
-//	@Param		request			body		models.DeleteMapSummaryRequest	true	"Body"
-//	@Success	200				{object}	models.Response{data=models.DeleteMapSummaryRequest}
-//	@Failure	400				{object}	models.Response
-//	@Router		/maps/{id}/summary [delete]
+//	@Description	Delete map summary with specified map id.
+//	@Tags			maps
+//	@Produce		json
+//	@Param			Authorization	header		string							true	"JWT Token"
+//	@Param			id				path		int								true	"Map ID"
+//	@Param			request			body		models.DeleteMapSummaryRequest	true	"Body"
+//	@Success		200				{object}	models.Response{data=models.DeleteMapSummaryRequest}
+//	@Failure		400				{object}	models.Response
+//	@Router			/maps/{id}/summary [delete]
 func DeleteMapSummary(c *gin.Context) {
 	// Check if user exists
 	user, exists := c.Get("user")
-- 
cgit v1.2.3