Skip to content

Add javadoc to generated gRPC service class public API #3

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
merlimat merged 1 commit into from
Mar 17, 2026
Merged

Add javadoc to generated gRPC service class public API #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions code-generator/src/main/java/io/streamnative/lightproto/generator/LightProtoService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,12 @@ public void generate(PrintWriter w) {
}

// Factory methods
w.format(" /** Creates a new async stub for the {@code %s} service. */\n", serviceName);
w.format(" public static %sStub newStub(io.grpc.Channel channel) {\n", serviceName);
w.format(" return %sStub.newStub(new %sStub.%sStubFactory(), channel);\n", serviceName, serviceName, serviceName);
w.format(" }\n\n");

w.format(" /** Creates a new blocking stub for the {@code %s} service. */\n", serviceName);
w.format(" public static %sBlockingStub newBlockingStub(io.grpc.Channel channel) {\n", serviceName);
w.format(" return %sBlockingStub.newStub(new %sBlockingStub.%sBlockingStubFactory(), channel);\n",
serviceName, serviceName, serviceName);
Expand Down Expand Up @@ -175,6 +177,11 @@ private void generateMethodDescriptor(PrintWriter w, ProtoMethodDescriptor m, St
w.format(" private static volatile io.grpc.MethodDescriptor<%s, %s> %s;\n\n",
inputType, outputType, fieldName);

if (m.getDoc() != null && !m.getDoc().isEmpty()) {
Util.writeJavadoc(w, m.getDoc(), " ");
} else {
w.format(" /** Returns the method descriptor for the {@code %s} RPC. */\n", methodName);
}
w.format(" public static io.grpc.MethodDescriptor<%s, %s> %s() {\n",
inputType, outputType, getterName);
w.format(" io.grpc.MethodDescriptor<%s, %s> result;\n", inputType, outputType);
Expand All @@ -197,6 +204,8 @@ private void generateMethodDescriptor(PrintWriter w, ProtoMethodDescriptor m, St
}

private void generateAsyncService(PrintWriter w, List<ProtoMethodDescriptor> methods) {
w.format(" /** Async service interface for the {@code %s} service. */\n",
service.getName());
w.println(" public interface AsyncService {");
for (ProtoMethodDescriptor m : methods) {
String ccMethod = javaMethodName(m.getName());
Expand All @@ -222,6 +231,7 @@ private void generateAsyncService(PrintWriter w, List<ProtoMethodDescriptor> met
}

private void generateImplBase(PrintWriter w, String serviceName) {
w.format(" /** Base implementation of the {@code %s} service. */\n", serviceName);
w.format(" public static abstract class %sImplBase implements io.grpc.BindableService, AsyncService {\n",
serviceName);
w.format(" @Override\n");
Expand All @@ -234,6 +244,7 @@ private void generateImplBase(PrintWriter w, String serviceName) {
private void generateStub(PrintWriter w, String serviceName, List<ProtoMethodDescriptor> methods) {
String stubName = serviceName + "Stub";

w.format(" /** Async stub for the {@code %s} service. */\n", serviceName);
w.format(" public static final class %s extends io.grpc.stub.AbstractStub<%s> {\n", stubName, stubName);
w.format(" private %s(io.grpc.Channel channel, io.grpc.CallOptions callOptions) {\n", stubName);
w.format(" super(channel, callOptions);\n");
Expand Down Expand Up @@ -292,6 +303,7 @@ private void generateStub(PrintWriter w, String serviceName, List<ProtoMethodDes
private void generateBlockingStub(PrintWriter w, String serviceName, List<ProtoMethodDescriptor> methods) {
String stubName = serviceName + "BlockingStub";

w.format(" /** Blocking stub for the {@code %s} service. */\n", serviceName);
w.format(" public static final class %s extends io.grpc.stub.AbstractStub<%s> {\n", stubName, stubName);
w.format(" private %s(io.grpc.Channel channel, io.grpc.CallOptions callOptions) {\n", stubName);
w.format(" super(channel, callOptions);\n");
Expand Down Expand Up @@ -397,6 +409,8 @@ private void generateMethodHandlers(PrintWriter w, String serviceName, List<Prot
private void generateServiceDescriptor(PrintWriter w, String grpcClassName, List<ProtoMethodDescriptor> methods) {
w.format(" private static volatile io.grpc.ServiceDescriptor serviceDescriptor;\n\n");

w.format(" /** Returns the service descriptor for the {@code %s} service. */\n",
grpcClassName.replace("Grpc", ""));
w.format(" public static io.grpc.ServiceDescriptor getServiceDescriptor() {\n");
w.format(" io.grpc.ServiceDescriptor result = serviceDescriptor;\n");
w.format(" if (result == null) {\n");
Expand All @@ -417,6 +431,7 @@ private void generateServiceDescriptor(PrintWriter w, String grpcClassName, List
}

private void generateBindService(PrintWriter w, List<ProtoMethodDescriptor> methods) {
w.println(" /** Binds the given {@code AsyncService} implementation and returns a {@code ServerServiceDefinition}. */");
w.println(" public static io.grpc.ServerServiceDefinition bindService(AsyncService service) {");
w.println(" return io.grpc.ServerServiceDefinition.builder(getServiceDescriptor())");
for (ProtoMethodDescriptor m : methods) {
Expand Down
Loading