Skip to content

feat: support multiline doc strings #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Brendan Le Glaunec (Ullaakut) merged 4 commits into from
May 5, 2025
Merged

feat: support multiline doc strings #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
09c5c81
feat: support multiline doc strings
Ullaakut May 2, 2025
cddc822
fix: apply PR suggestions
Ullaakut May 5, 2025
d133799
feat: add example of multiline docs in gen tests
Ullaakut May 5, 2025
2af4b6a
Merge branch 'main' into 17-fix-doc-line-breaks
Ullaakut May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion cmd/oapi-gen/gen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,8 @@ func docToString(cg *ast.CommentGroup) string {
return ""
}

s = strings.Join(strings.Split(s, "\n"), " ")
s = strings.TrimSuffix(s, "\n")
s = strings.Join(strings.Split(s, "\n"), "\\n") // Escape newlines.
return strings.TrimSpace(s)
}

Expand Down
2 changes: 1 addition & 1 deletion cmd/oapi-gen/testdata/all.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cmd/oapi-gen/testdata/not-all.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion cmd/oapi-gen/testdata/test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ package testdata
//
//openapi:gen
type TestObject struct {
// A is an example field with "quotes".
// A is an example field with "quotes"
// and a newline.
A string `json:"a"`

// B is another example field.
Expand Down
2 changes: 1 addition & 1 deletion gen_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ type TestObject struct {

func (TestObject) Docs() map[string]string {
return map[string]string{
"test1": "Some test docs",
"test1": "Test1 is an documented field with "quotes"\nand a newline.",
}
}

Expand Down
2 changes: 1 addition & 1 deletion testdata/spec-pkgseg0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
},
"properties": {
"test1": {
"description": "Some test docs",
"description": "Test1 is an documented field with \u0026#34;quotes\u0026#34;\nand a newline.",
"type": "string"
},
"test2": {
Expand Down
2 changes: 1 addition & 1 deletion testdata/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
},
"properties": {
"test1": {
"description": "Some test docs",
"description": "Test1 is an documented field with \u0026#34;quotes\u0026#34;\nand a newline.",
"type": "string"
},
"test2": {
Expand Down
Loading