impl(generator): move doc formatting to Codec #89
Conversation
This file contains 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
Each language codec will need to make slightly different adjustments to the documentation comments. This PR moves the splitting and cleanup of each line to the Codec, and introduces some Rust specific cleanups.
julieqiu
approved these changes
Nov 4, 2024
| @@ -82,6 +82,15 @@ type LanguageCodec interface { | |||
| // "lowercase CamelCase"), applying any mangling required by the language, | |||
| // e.g., to avoid clashes with reserved words. | |||
| ToCamel(string) string | |||
| // Reformat ${Lang}Doc comments according to the language-specific rules. | |||
| // For example, | |||
| // - The protos in googleapis include cross-references in the format | |||
There was a problem hiding this comment.
nit: use 2 spaces per https://tip.golang.org/doc/comment#lists
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Each language codec will need to make slightly different adjustments to the
documentation comments. This PR moves the splitting and cleanup of each line to
the Codec, and introduces some Rust specific cleanups.
Fixes #57 and fixes #33