You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: vertx-grpc-docs/src/main/asciidoc/plugin.adoc
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -159,14 +159,15 @@ By default, the plugin generates both client and service files. If you need only
159
159
160
160
=== Arguments:
161
161
162
-
- _[--]grpc-client_: generate the client files
163
-
- _[--]grpc-service_: generate the service files
164
-
- _[--]grpc-io_: generate stub files compatible with `io.grpc:grpc-stub`, not generated by default. When using this option, you must also ensure the grpc-java plugin is configured (as shown in the Maven configuration above)
165
-
- _[--]grpc-transcoding_: whether to generate transcoding options for methods with HTTP annotations
166
-
- _[--]vertx-codegen_: whether to add Vert.x annotations to the generated classes (`@VertxGen`) By default, this is disabled
167
-
- _[--]service-prefix_: generate service classes with a prefix. For example, if you set it to `MyService`, the generated service class will be `MyServiceGreeterService` instead of `GreeterService`.
162
+
- _[--]grpc-client[=true/false]_: generate the client files
163
+
- _[--]grpc-service[=true/false]_: generate the service files
164
+
- _[--]grpc-io[=true/false]_: generate stub files compatible with `io.grpc:grpc-stub`, not generated by default. When using this option, you must also ensure the grpc-java plugin is configured (as shown in the Maven configuration above)
165
+
- _[--]grpc-transcoding[=true/false]_: whether to generate transcoding options for methods with HTTP annotations
166
+
- _[--]vertx-codegen[=true/false]_: whether to add Vert.x annotations to the generated classes (`@VertxGen`) By default, this is disabled
167
+
- _[--]service-prefix[=Your Name]_: generate service classes with a prefix. For example, if you set it to `MyService`, the generated service class will be `MyServiceGreeterService` instead of `GreeterService`.
168
168
169
169
* [--] This means the argument can be prefixed with `--` when used as JVM arguments, but should be used without `--` when specified in the options tag. If possible, users should use plugin options as a more universal protoc plugin approach.
170
+
* [=value] This means the argument can optionally specify a value. For boolean arguments (true/false), if no value is specified, the default is `true` when the argument is present. For string arguments like `service-prefix`, a value must be provided.
170
171
171
172
If no specific generation options are provided, both client and service files will be generated by default. By default, all extensions (currently only 'http') are supported.
0 commit comments