From 26ce0c36f1678c9a9a1c85aad81fa3ddcfffd2c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=93=D1=83=D1=81=D0=B5=D0=B2=20=D0=98=D0=BB=D1=8C=D1=8F?= Date: Thu, 20 Jan 2022 16:57:47 +0300 Subject: [PATCH] Corrected swagger documentation (#708) --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c9e372bd..5e62e18d3 100644 --- a/README.md +++ b/README.md @@ -623,7 +623,10 @@ type Account struct { } ``` -generated swagger doc as follows: +[#708](https://github.com/swaggo/swag/issues/708) The parser handles only struct comments starting with `@Description` attribute. +But it writes all struct field comments as is. + +So, generated swagger doc as follows: ```json "Account": { "type":"object",