render comments in webrpc methods (#67)

webrpc · Apr 24, 2024 · 63ec3bf · 63ec3bf
1 parent badb0e7
commit 63ec3bf
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/_examples/golang-basics/example.gen.go b/_examples/golang-basics/example.gen.go
diff --git a/_examples/golang-basics/example.ridl b/_examples/golang-basics/example.ridl
@@ -89,6 +89,9 @@ error 400300 UserNotFound    "user not found"
 
 service ExampleService
   - Ping()
+  # Status endpoint
+  #
+  # gives you current status of running application
   - Status() => (status: bool)
   - Version() => (version: Version)
   - GetUser(header: map<string,string>, userID: uint64) => (user: User)

diff --git a/_examples/golang-imports/api.gen.go b/_examples/golang-imports/api.gen.go
diff --git a/types.go.tmpl b/types.go.tmpl
@@ -47,6 +47,11 @@ var WebRPCServices = map[string][]string{
 {{ if $opts.types -}}
 type {{$service.Name}} interface {
 	{{- range $_, $method := $service.Methods}}
+	{{- if gt (len $method.Comments) 0 -}}
+		{{- range $_, $comment := $method.Comments }}
+			// {{ replaceAll $comment "\"" "'" }}
+		{{- end }}
+	{{- end }}
 	{{ if eq $method.StreamOutput true -}}
 	{{$method.Name}}(ctx context.Context{{range $_, $input := $method.Inputs}}, {{$input.Name}} {{template "field" dict "Name" $input.Name "Type" $input.Type "TypeMap" $typeMap "TypePrefix" $typePrefix "Optional" $input.Optional "TypeMeta" $input.Meta}}{{end}}, stream {{$method.Name}}StreamWriter) error
 	{{- else -}}
@@ -144,6 +149,11 @@ func (w *streamWriter) write(respPayload interface{}) error {
 {{ range $_, $service := $services -}}
 type {{$service.Name}}Client interface {
 	{{- range $_, $method := $service.Methods}}
+	{{- if gt (len $method.Comments) 0 }}
+		{{- range $_, $comment := $method.Comments }}
+			// {{ replaceAll $comment "\"" "'" }}
+		{{- end }}
+	{{- end }}
 	{{ if eq $method.StreamOutput true -}}
 	{{$method.Name}}(ctx context.Context{{range $_, $input := $method.Inputs}}, {{$input.Name}} {{template "field" dict "Name" $input.Name "Type" $input.Type "TypeMap" $typeMap "TypePrefix" $typePrefix "Optional" $input.Optional "TypeMeta" $input.Meta}}{{end}}) ({{$method.Name}}StreamReader, error)
 	{{- else -}}