Improve documentation of generated classes.#234
Merged
zZHorizonZz merged 1 commit intoeclipse-vertx:mainfrom Feb 13, 2026
Merged
Improve documentation of generated classes.#234zZHorizonZz merged 1 commit intoeclipse-vertx:mainfrom
zZHorizonZz merged 1 commit intoeclipse-vertx:mainfrom
Conversation
Motivation: - Improve documentation to include references for idiomatic gRPC/IO client and server APIs. - Provide clear comparisons between high-level and low-level APIs for clarity. Changes: - Updated `ioclient.adoc` and `ioserver.adoc` with new sections for idiomatic gRPC/IO APIs. - Added detailed descriptions and tables in `plugin.adoc` to explain generated RPC files and their purposes. - Added anchors for client and server request/response API sections (`client-request-response-api`, `server-request-response-api`).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation:
Changes:
ioclient.adocandioserver.adocwith new sections for idiomatic gRPC/IO APIs.plugin.adocto explain generated RPC files and their purposes.client-request-response-api,server-request-response-api).