Corrected swagger documentation (swaggo#708)

KuboOrk · Jan 20, 2022 · 26ce0c3 · 26ce0c3
1 parent d7a5867
commit 26ce0c3
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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",