feat: support line-comments to struct comment (#356)

swaggo · Mar 26, 2019 · e4ec0fe · e4ec0fe
1 parent 92f098d
commit e4ec0fe
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -502,8 +502,9 @@ type Account struct {
 
 ```go
 type Account struct {
- // ID this is userid
- ID int `json:"id"
+ // ID this is userid
+ ID int `json:"id"`
+ Name string `json:"name"` // This is Name
 }
 ```
 

diff --git a/parser.go b/parser.go
@@ -701,6 +701,9 @@ func (parser *Parser) parseStruct(pkgName string, field *ast.Field) (map[string]
  if field.Doc != nil {
  desc = strings.TrimSpace(field.Doc.Text())
  }
+ if desc == "" && field.Comment != nil {
+ desc = strings.TrimSpace(field.Comment.Text())
+ }
  // TODO: find package of schemaType and/or arrayType
 
  if structField.crossPkg != "" {

diff --git a/parser_test.go b/parser_test.go
@@ -1893,6 +1893,7 @@ func TestParseStructComment(t *testing.T) {
  "type": "object",
  "properties": {
  "createdAt": {
+ "description": "Error time",
  "type": "string"
  },
  "error": {

diff --git a/testdata/struct_comment/web/handler.go b/testdata/struct_comment/web/handler.go
@@ -17,6 +17,6 @@ type Post struct {
 
 type APIError struct {
  // Error an Api error
- Error string
- CreatedAt time.Time
+ Error string // Error this is Line comment
+ CreatedAt time.Time // Error time
 }