Skip to content

Commit

Permalink
Feat:copy service comment to interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
silves-xiang committed May 18, 2024
1 parent e22436a commit 4daef8f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions cmd/protoc-gen-go-grpc/grpc.go
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,9 @@ func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.Generated
g.P("// ", clientName, " is the client API for ", service.GoName, " service.")
g.P("//")
g.P("// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.")
g.P() // for vscode dosn't display top of comment
// print comment without '\n', if comment has '\n', vscode dosn't display it
g.P(strings.TrimSpace(service.Comments.Leading.String()))

if service.Desc.Options().(*descriptorpb.ServiceOptions).GetDeprecated() {
g.P("//")
Expand Down Expand Up @@ -251,6 +254,10 @@ func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.Generated
g.P("// ", serverType, " is the server API for ", service.GoName, " service.")
g.P("// All implementations ", mustOrShould, " embed Unimplemented", serverType)
g.P("// for forward compatibility")
g.P() // for vscode dosn't display top of comment
// print comment without '\n', if comment has '\n', vscode dosn't display it
g.P(strings.TrimSpace(service.Comments.Leading.String()))

if service.Desc.Options().(*descriptorpb.ServiceOptions).GetDeprecated() {
g.P("//")
g.P(deprecationComment)
Expand Down

0 comments on commit 4daef8f

Please sign in to comment.