fmt cmd: use a tab instead of two spaces to format comments (#1386)

* fmt cmd: use a tab instead of two spaces to format comments * fmt cmd: continuous spaces and tabs should be replaced with a single tab
swaggo · Nov 18, 2022 · 829fbe1 · 829fbe1
1 parent eaed517
commit 829fbe1
Show file tree

Hide file tree

Showing 17 changed files with 429 additions and 430 deletions.
diff --git a/example/basic/api/api.go b/example/basic/api/api.go
@@ -9,17 +9,17 @@ import (
 
 // GetStringByInt example
 //
-//	@Summary      Add a new pet to the store
-//	@Description  get string by ID
-//	@ID           get-string-by-int
-//	@Accept       json
-//	@Produce      json
-//	@Param        some_id  path      int           true  "Some ID"
-//	@Param        some_id  body      web.Pet       true  "Some ID"
-//	@Success      200      {string}  string        "ok"
-//	@Failure      400      {object}  web.APIError  "We need ID!!"
-//	@Failure      404      {object}  web.APIError  "Can not find ID"
-//	@Router       /testapi/get-string-by-int/{some_id} [get]
+//	@Summary		Add a new pet to the store
+//	@Description	get string by ID
+//	@ID				get-string-by-int
+//	@Accept			json
+//	@Produce		json
+//	@Param			some_id	path		int				true	"Some ID"
+//	@Param			some_id	body		web.Pet			true	"Some ID"
+//	@Success		200		{string}	string			"ok"
+//	@Failure		400		{object}	web.APIError	"We need ID!!"
+//	@Failure		404		{object}	web.APIError	"Can not find ID"
+//	@Router			/testapi/get-string-by-int/{some_id} [get]
 func GetStringByInt(w http.ResponseWriter, r *http.Request) {
 	var pet web.Pet
 	if err := json.NewDecoder(r.Body).Decode(&pet); err != nil {
@@ -32,41 +32,41 @@ func GetStringByInt(w http.ResponseWriter, r *http.Request) {
 
 // GetStructArrayByString example
 //
-//	@Description  get struct array by ID
-//	@ID           get-struct-array-by-string
-//	@Accept       json
-//	@Produce      json
-//	@Param        some_id  path      string        true  "Some ID"
-//	@Param        offset   query     int           true  "Offset"
-//	@Param        limit    query     int           true  "Offset"
-//	@Success      200      {string}  string        "ok"
-//	@Failure      400      {object}  web.APIError  "We need ID!!"
-//	@Failure      404      {object}  web.APIError  "Can not find ID"
-//	@Router       /testapi/get-struct-array-by-string/{some_id} [get]
+//	@Description	get struct array by ID
+//	@ID				get-struct-array-by-string
+//	@Accept			json
+//	@Produce		json
+//	@Param			some_id	path		string			true	"Some ID"
+//	@Param			offset	query		int				true	"Offset"
+//	@Param			limit	query		int				true	"Offset"
+//	@Success		200		{string}	string			"ok"
+//	@Failure		400		{object}	web.APIError	"We need ID!!"
+//	@Failure		404		{object}	web.APIError	"Can not find ID"
+//	@Router			/testapi/get-struct-array-by-string/{some_id} [get]
 func GetStructArrayByString(w http.ResponseWriter, r *http.Request) {
 	// write your code
 }
 
 // Upload example
 //
-//	@Summary      Upload file
-//	@Description  Upload file
-//	@ID           file.upload
-//	@Accept       multipart/form-data
-//	@Produce      json
-//	@Param        file  formData  file          true  "this is a test file"
-//	@Success      200   {string}  string        "ok"
-//	@Failure      400   {object}  web.APIError  "We need ID!!"
-//	@Failure      404   {object}  web.APIError  "Can not find ID"
-//	@Router       /file/upload [post]
+//	@Summary		Upload file
+//	@Description	Upload file
+//	@ID				file.upload
+//	@Accept			multipart/form-data
+//	@Produce		json
+//	@Param			file	formData	file			true	"this is a test file"
+//	@Success		200		{string}	string			"ok"
+//	@Failure		400		{object}	web.APIError	"We need ID!!"
+//	@Failure		404		{object}	web.APIError	"Can not find ID"
+//	@Router			/file/upload [post]
 func Upload(w http.ResponseWriter, r *http.Request) {
 	// write your code
 }
 
 // AnonymousField example
 //
-//	@Summary  use Anonymous field
-//	@Success  200  {object}  web.RevValue  "ok"
+//	@Summary	use Anonymous field
+//	@Success	200	{object}	web.RevValue	"ok"
 func AnonymousField() {
 
 }

diff --git a/example/basic/main.go b/example/basic/main.go
@@ -6,20 +6,20 @@ import (
 	"github.com/swaggo/swag/example/basic/api"
 )
 
-//  @title           Swagger Example API
-//  @version         1.0
-//  @description     This is a sample server Petstore server.
-//  @termsOfService  http://swagger.io/terms/
+//	@title			Swagger Example API
+//	@version		1.0
+//	@description	This is a sample server Petstore server.
+//	@termsOfService	http://swagger.io/terms/
 
-//  @contact.name   API Support
-//  @contact.url    http://www.swagger.io/support
-//  @contact.email  support@swagger.io
+//	@contact.name	API Support
+//	@contact.url	http://www.swagger.io/support
+//	@contact.email	support@swagger.io
 
-//  @license.name  Apache 2.0
-//  @license.url   http://www.apache.org/licenses/LICENSE-2.0.html
+//	@license.name	Apache 2.0
+//	@license.url	http://www.apache.org/licenses/LICENSE-2.0.html
 
-//  @host      petstore.swagger.io
-//  @BasePath  /v2
+//	@host		petstore.swagger.io
+//	@BasePath	/v2
 
 func main() {
 	http.HandleFunc("/testapi/get-string-by-int/", api.GetStringByInt)

diff --git a/example/celler/controller/accounts.go b/example/celler/controller/accounts.go
@@ -12,17 +12,17 @@ import (
 
 // ShowAccount godoc
 //
-//	@Summary      Show an account
-//	@Description  get string by ID
-//	@Tags         accounts
-//	@Accept       json
-//	@Produce      json
-//	@Param        id   path      int  true  "Account ID"
-//	@Success      200  {object}  model.Account
-//	@Failure      400  {object}  httputil.HTTPError
-//	@Failure      404  {object}  httputil.HTTPError
-//	@Failure      500  {object}  httputil.HTTPError
-//	@Router       /accounts/{id} [get]
+//	@Summary		Show an account
+//	@Description	get string by ID
+//	@Tags			accounts
+//	@Accept			json
+//	@Produce		json
+//	@Param			id	path		int	true	"Account ID"
+//	@Success		200	{object}	model.Account
+//	@Failure		400	{object}	httputil.HTTPError
+//	@Failure		404	{object}	httputil.HTTPError
+//	@Failure		500	{object}	httputil.HTTPError
+//	@Router			/accounts/{id} [get]
 func (c *Controller) ShowAccount(ctx *gin.Context) {
 	id := ctx.Param("id")
 	aid, err := strconv.Atoi(id)
@@ -40,17 +40,17 @@ func (c *Controller) ShowAccount(ctx *gin.Context) {
 
 // ListAccounts godoc
 //
-//	@Summary      List accounts
-//	@Description  get accounts
-//	@Tags         accounts
-//	@Accept       json
-//	@Produce      json
-//	@Param        q    query     string  false  "name search by q"  Format(email)
-//	@Success      200  {array}   model.Account
-//	@Failure      400  {object}  httputil.HTTPError
-//	@Failure      404  {object}  httputil.HTTPError
-//	@Failure      500  {object}  httputil.HTTPError
-//	@Router       /accounts [get]
+//	@Summary		List accounts
+//	@Description	get accounts
+//	@Tags			accounts
+//	@Accept			json
+//	@Produce		json
+//	@Param			q	query		string	false	"name search by q"	Format(email)
+//	@Success		200	{array}		model.Account
+//	@Failure		400	{object}	httputil.HTTPError
+//	@Failure		404	{object}	httputil.HTTPError
+//	@Failure		500	{object}	httputil.HTTPError
+//	@Router			/accounts [get]
 func (c *Controller) ListAccounts(ctx *gin.Context) {
 	q := ctx.Request.URL.Query().Get("q")
 	accounts, err := model.AccountsAll(q)
@@ -63,17 +63,17 @@ func (c *Controller) ListAccounts(ctx *gin.Context) {
 
 // AddAccount godoc
 //
-//	@Summary      Add an account
-//	@Description  add by json account
-//	@Tags         accounts
-//	@Accept       json
-//	@Produce      json
-//	@Param        account  body      model.AddAccount  true  "Add account"
-//	@Success      200      {object}  model.Account
-//	@Failure      400      {object}  httputil.HTTPError
-//	@Failure      404      {object}  httputil.HTTPError
-//	@Failure      500      {object}  httputil.HTTPError
-//	@Router       /accounts [post]
+//	@Summary		Add an account
+//	@Description	add by json account
+//	@Tags			accounts
+//	@Accept			json
+//	@Produce		json
+//	@Param			account	body		model.AddAccount	true	"Add account"
+//	@Success		200		{object}	model.Account
+//	@Failure		400		{object}	httputil.HTTPError
+//	@Failure		404		{object}	httputil.HTTPError
+//	@Failure		500		{object}	httputil.HTTPError
+//	@Router			/accounts [post]
 func (c *Controller) AddAccount(ctx *gin.Context) {
 	var addAccount model.AddAccount
 	if err := ctx.ShouldBindJSON(&addAccount); err != nil {
@@ -98,18 +98,18 @@ func (c *Controller) AddAccount(ctx *gin.Context) {
 
 // UpdateAccount godoc
 //
-//	@Summary      Update an account
-//	@Description  Update by json account
-//	@Tags         accounts
-//	@Accept       json
-//	@Produce      json
-//	@Param        id       path      int                  true  "Account ID"
-//	@Param        account  body      model.UpdateAccount  true  "Update account"
-//	@Success      200      {object}  model.Account
-//	@Failure      400      {object}  httputil.HTTPError
-//	@Failure      404      {object}  httputil.HTTPError
-//	@Failure      500      {object}  httputil.HTTPError
-//	@Router       /accounts/{id} [patch]
+//	@Summary		Update an account
+//	@Description	Update by json account
+//	@Tags			accounts
+//	@Accept			json
+//	@Produce		json
+//	@Param			id		path		int					true	"Account ID"
+//	@Param			account	body		model.UpdateAccount	true	"Update account"
+//	@Success		200		{object}	model.Account
+//	@Failure		400		{object}	httputil.HTTPError
+//	@Failure		404		{object}	httputil.HTTPError
+//	@Failure		500		{object}	httputil.HTTPError
+//	@Router			/accounts/{id} [patch]
 func (c *Controller) UpdateAccount(ctx *gin.Context) {
 	id := ctx.Param("id")
 	aid, err := strconv.Atoi(id)
@@ -136,17 +136,17 @@ func (c *Controller) UpdateAccount(ctx *gin.Context) {
 
 // DeleteAccount godoc
 //
-//	@Summary      Delete an account
-//	@Description  Delete by account ID
-//	@Tags         accounts
-//	@Accept       json
-//	@Produce      json
-//	@Param        id   path      int  true  "Account ID"  Format(int64)
-//	@Success      204  {object}  model.Account
-//	@Failure      400  {object}  httputil.HTTPError
-//	@Failure      404  {object}  httputil.HTTPError
-//	@Failure      500  {object}  httputil.HTTPError
-//	@Router       /accounts/{id} [delete]
+//	@Summary		Delete an account
+//	@Description	Delete by account ID
+//	@Tags			accounts
+//	@Accept			json
+//	@Produce		json
+//	@Param			id	path		int	true	"Account ID"	Format(int64)
+//	@Success		204	{object}	model.Account
+//	@Failure		400	{object}	httputil.HTTPError
+//	@Failure		404	{object}	httputil.HTTPError
+//	@Failure		500	{object}	httputil.HTTPError
+//	@Router			/accounts/{id} [delete]
 func (c *Controller) DeleteAccount(ctx *gin.Context) {
 	id := ctx.Param("id")
 	aid, err := strconv.Atoi(id)
@@ -164,18 +164,18 @@ func (c *Controller) DeleteAccount(ctx *gin.Context) {
 
 // UploadAccountImage godoc
 //
-//	@Summary      Upload account image
-//	@Description  Upload file
-//	@Tags         accounts
-//	@Accept       multipart/form-data
-//	@Produce      json
-//	@Param        id    path      int   true  "Account ID"
-//	@Param        file  formData  file  true  "account image"
-//	@Success      200   {object}  controller.Message
-//	@Failure      400   {object}  httputil.HTTPError
-//	@Failure      404   {object}  httputil.HTTPError
-//	@Failure      500   {object}  httputil.HTTPError
-//	@Router       /accounts/{id}/images [post]
+//	@Summary		Upload account image
+//	@Description	Upload file
+//	@Tags			accounts
+//	@Accept			multipart/form-data
+//	@Produce		json
+//	@Param			id		path		int		true	"Account ID"
+//	@Param			file	formData	file	true	"account image"
+//	@Success		200		{object}	controller.Message
+//	@Failure		400		{object}	httputil.HTTPError
+//	@Failure		404		{object}	httputil.HTTPError
+//	@Failure		500		{object}	httputil.HTTPError
+//	@Router			/accounts/{id}/images [post]
 func (c *Controller) UploadAccountImage(ctx *gin.Context) {
 	id, err := strconv.Atoi(ctx.Param("id"))
 	if err != nil {

diff --git a/example/celler/controller/admin.go b/example/celler/controller/admin.go
@@ -12,18 +12,18 @@ import (
 
 // Auth godoc
 //
-//	@Summary      Auth admin
-//	@Description  get admin info
-//	@Tags         accounts,admin
-//	@Accept       json
-//	@Produce      json
-//	@Success      200  {object}  model.Admin
-//	@Failure      400  {object}  httputil.HTTPError
-//	@Failure      401  {object}  httputil.HTTPError
-//	@Failure      404  {object}  httputil.HTTPError
-//	@Failure      500  {object}  httputil.HTTPError
-//	@Security     ApiKeyAuth
-//	@Router       /admin/auth [post]
+//	@Summary		Auth admin
+//	@Description	get admin info
+//	@Tags			accounts,admin
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{object}	model.Admin
+//	@Failure		400	{object}	httputil.HTTPError
+//	@Failure		401	{object}	httputil.HTTPError
+//	@Failure		404	{object}	httputil.HTTPError
+//	@Failure		500	{object}	httputil.HTTPError
+//	@Security		ApiKeyAuth
+//	@Router			/admin/auth [post]
 func (c *Controller) Auth(ctx *gin.Context) {
 	authHeader := ctx.GetHeader("Authorization")
 	if len(authHeader) == 0 {

diff --git a/example/celler/controller/bottles.go b/example/celler/controller/bottles.go
@@ -12,18 +12,18 @@ import (
 
 // ShowBottle godoc
 //
-//	@Summary      Show a bottle
-//	@Description  get string by ID
-//	@ID           get-string-by-int
-//	@Tags         bottles
-//	@Accept       json
-//	@Produce      json
-//	@Param        id   path      int  true  "Bottle ID"
-//	@Success      200  {object}  model.Bottle
-//	@Failure      400  {object}  httputil.HTTPError
-//	@Failure      404  {object}  httputil.HTTPError
-//	@Failure      500  {object}  httputil.HTTPError
-//	@Router       /bottles/{id} [get]
+//	@Summary		Show a bottle
+//	@Description	get string by ID
+//	@ID				get-string-by-int
+//	@Tags			bottles
+//	@Accept			json
+//	@Produce		json
+//	@Param			id	path		int	true	"Bottle ID"
+//	@Success		200	{object}	model.Bottle
+//	@Failure		400	{object}	httputil.HTTPError
+//	@Failure		404	{object}	httputil.HTTPError
+//	@Failure		500	{object}	httputil.HTTPError
+//	@Router			/bottles/{id} [get]
 func (c *Controller) ShowBottle(ctx *gin.Context) {
 	id := ctx.Param("id")
 	bid, err := strconv.Atoi(id)
@@ -41,16 +41,16 @@ func (c *Controller) ShowBottle(ctx *gin.Context) {
 
 // ListBottles godoc
 //
-//	@Summary      List bottles
-//	@Description  get bottles
-//	@Tags         bottles
-//	@Accept       json
-//	@Produce      json
-//	@Success      200  {array}   model.Bottle
-//	@Failure      400  {object}  httputil.HTTPError
-//	@Failure      404  {object}  httputil.HTTPError
-//	@Failure      500  {object}  httputil.HTTPError
-//	@Router       /bottles [get]
+//	@Summary		List bottles
+//	@Description	get bottles
+//	@Tags			bottles
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{array}		model.Bottle
+//	@Failure		400	{object}	httputil.HTTPError
+//	@Failure		404	{object}	httputil.HTTPError
+//	@Failure		500	{object}	httputil.HTTPError
+//	@Router			/bottles [get]
 func (c *Controller) ListBottles(ctx *gin.Context) {
 	bottles, err := model.BottlesAll()
 	if err != nil {