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/loginController.go | 38 +++++++++++++++++-----------------
 1 file changed, 19 insertions(+), 19 deletions(-)

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

diff --git a/backend/controllers/loginController.go b/backend/controllers/loginController.go
index b30d26e..ae6e957 100644
--- a/backend/controllers/loginController.go
+++ b/backend/controllers/loginController.go
@@ -17,13 +17,13 @@ import (
 
 // Login
 //
-//	@Summary	Get (redirect) login page for Steam auth.
-//	@Tags		login
-//	@Accept		json
-//	@Produce	json
-//	@Success	200	{object}	models.Response{data=models.LoginResponse}
-//	@Failure	400	{object}	models.Response
-//	@Router		/login [get]
+//	@Description	Get (redirect) login page for Steam auth.
+//	@Tags			login
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{object}	models.Response{data=models.LoginResponse}
+//	@Failure		400	{object}	models.Response
+//	@Router			/login [get]
 func Login(c *gin.Context) {
 	openID := steam_go.NewOpenId(c.Request)
 	switch openID.Mode() {
@@ -95,13 +95,13 @@ func Login(c *gin.Context) {
 
 // GET Token
 //
-//	@Summary	Gets the token cookie value from the user.
-//	@Tags		auth
-//	@Produce	json
+//	@Description	Gets the token cookie value from the user.
+//	@Tags			auth
+//	@Produce		json
 //
-//	@Success	200	{object}	models.Response{data=models.LoginResponse}
-//	@Failure	404	{object}	models.Response
-//	@Router		/token [get]
+//	@Success		200	{object}	models.Response{data=models.LoginResponse}
+//	@Failure		404	{object}	models.Response
+//	@Router			/token [get]
 func GetCookie(c *gin.Context) {
 	cookie, err := c.Cookie("token")
 	if err != nil {
@@ -119,13 +119,13 @@ func GetCookie(c *gin.Context) {
 
 // DELETE Token
 //
-//	@Summary	Deletes the token cookie from the user.
-//	@Tags		auth
-//	@Produce	json
+//	@Description	Deletes the token cookie from the user.
+//	@Tags			auth
+//	@Produce		json
 //
-//	@Success	200	{object}	models.Response{data=models.LoginResponse}
-//	@Failure	404	{object}	models.Response
-//	@Router		/token [delete]
+//	@Success		200	{object}	models.Response{data=models.LoginResponse}
+//	@Failure		404	{object}	models.Response
+//	@Router			/token [delete]
 func DeleteCookie(c *gin.Context) {
 	cookie, err := c.Cookie("token")
 	if err != nil {
-- 
cgit v1.2.3