[dart] fix: handle multiline x-enum-descriptions - #24881
Merged
wing328 merged 1 commit intoSep 6, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 9 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Mattias-Sehlstedt
force-pushed
the
dart-multiline-enum-description
branch
from
September 5, 2026 19:26
a0b8ce4 to
33b2029
Compare
Mattias-Sehlstedt
force-pushed
the
dart-multiline-enum-description
branch
from
September 5, 2026 19:29
33b2029 to
7073cc2
Compare
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 13 files (changes from recent commits).
Tip: Review your code locally with the cubic CLI to iterate faster.
Re-trigger cubic
Member
|
thanks for the fix cc @jaumard (2018/09) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08) |
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
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.
Fixes so that dart can handle multiline
x-enum-descriptions. This is done by changing the doc to/** ... */and introducing a lambda to prefix each line with a*. Note that*is technically superfluous, and it is for example not used in the Java handling.Reverted strange indent changes to
enum.mustachefrom here, and instead made it a two-step indent as per every other definition in the template.Fixes #24858
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
Summary by cubic
Fixes the Dart generator emitting broken doc comments for multiline
x-enum-descriptionsby switching from///to/** ... */block comments and prefixing each line with*via new Mustache lambdas.Details
PrefixLambdaand thedartdoc/dartdoc_2lambdas inAbstractDartCodegen.built_valueandjson_serializableenum templates.Written for commit 7073cc2. Summary will update on new commits.