Skip to content

Commit 8636196

Browse files
committed
Feat:copy service comment to interfaces
1 parent e22436a commit 8636196

File tree

18 files changed

+99
-0
lines changed

18 files changed

+99
-0
lines changed

balancer/grpclb/grpc_lb_v1/load_balancer_grpc.pb.go

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

channelz/grpc_channelz_v1/channelz_grpc.pb.go

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/protoc-gen-go-grpc/grpc.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,14 @@ func generateFileContent(gen *protogen.Plugin, file *protogen.File, g *protogen.
187187
}
188188
}
189189

190+
// Copy comments from proto file to _grpc.pb.go file
191+
func copyCommentsFromProto(g *protogen.GeneratedFile, service *protogen.Service) {
192+
// Add empty comments line for godoc.
193+
g.P("//")
194+
// Pint comment without '\n', if comment has '\n', godoc considers this annotation to be non-service annotation.
195+
g.P(strings.TrimSpace(service.Comments.Leading.String()))
196+
}
197+
190198
func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFile, service *protogen.Service) {
191199
// Full methods constants.
192200
helper.genFullMethods(g, service)
@@ -198,6 +206,9 @@ func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.Generated
198206
g.P("//")
199207
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.")
200208

209+
// Copy comments from proto file.
210+
copyCommentsFromProto(g, service)
211+
201212
if service.Desc.Options().(*descriptorpb.ServiceOptions).GetDeprecated() {
202213
g.P("//")
203214
g.P(deprecationComment)
@@ -251,6 +262,10 @@ func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.Generated
251262
g.P("// ", serverType, " is the server API for ", service.GoName, " service.")
252263
g.P("// All implementations ", mustOrShould, " embed Unimplemented", serverType)
253264
g.P("// for forward compatibility")
265+
266+
// Copy comments from proto file.
267+
copyCommentsFromProto(g, service)
268+
254269
if service.Desc.Options().(*descriptorpb.ServiceOptions).GetDeprecated() {
255270
g.P("//")
256271
g.P(deprecationComment)

credentials/alts/internal/proto/grpc_gcp/handshaker_grpc.pb.go

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/features/proto/echo/echo_grpc.pb.go

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/helloworld/helloworld/helloworld_grpc.pb.go

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/route_guide/routeguide/route_guide_grpc.pb.go

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

health/grpc_health_v1/health_grpc.pb.go

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

internal/proto/grpc_lookup_v1/rls_grpc.pb.go

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

interop/grpc_testing/benchmark_service_grpc.pb.go

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)