github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-29 14:37:00 +00:00
Code Issues Projects Releases Wiki Activity

Strip go2idl instructions from generated swagger doc

Browse Source 
Ignore doc lines starting with +
This commit is contained in:
Clayton Coleman 2015-11-28 17:03:30 -05:00
parent a512d83a87
commit ac9fd648d3
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/runtime/swagger_doc_generator.go
View File

@ -65,11 +65,14 @@ func fmtRawDoc(rawDoc string) string {
for _, line := range strings.Split(rawDoc, "\n") {
line = strings.TrimRight(line, " ")
if line == "" { // Keep paragraphs
leading := strings.TrimLeft(line, " ")
switch {
case len(line) == 0: // Keep paragraphs
delPrevChar()
buffer.WriteString("\n\n")
} else if !strings.HasPrefix(strings.TrimLeft(line, " "), "TODO") { // Ignore one line TODOs
case strings.HasPrefix(leading, "TODO"): // Ignore one line TODOs
case strings.HasPrefix(leading, "+"): // Ignore instructions to go2idl
default:
if strings.HasPrefix(line, " ") || strings.HasPrefix(line, "\t") {
delPrevChar()
line = "\n" + line + "\n" // Replace it with newline. This is useful when we have a line with: "Example:\n\tJSON-someting..."