Refactor handling of generateDocs:false #4095
Merged
Conversation
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
szakarias
reviewed
Aug 26, 2025
srawlins
approved these changes
Aug 26, 2025
|
I have a couple of nits, I will add it in a follow-up PR. Also, I was thinking of a slightly different design, where we might want to keep the |
devoncarew
reviewed
Aug 28, 2025
| set generator(Generator newGenerator) => _generator = newGenerator; | ||
|
|
||
| /// Factory method that builds Dartdoc with an empty generator. | ||
| factory Dartdoc.withEmptyGenerator( |
There was a problem hiding this comment.
FYI, the dart tool is using this in its implementation of dart doc; see https://github.com/dart-lang/sdk/blob/main/pkg/dartdev/lib/src/commands/doc.dart#L119.
I'm sure its possible to update the tool for this change, but we'll want to do that as part of the next roll of this repo into the sdk.
There was a problem hiding this comment.
Thanks! I was unaware of that. I'll make a migration CL...
There was a problem hiding this comment.
Gotcha; tracking the work here so we don't lose track: #4100
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Not sure if anyone is using this option really. But I think the handling can be simplified.
But it seems that having multiple Generator classes just for deciding whether to write files or not is excessive, and likely to get out of sync (does the EmptyGenerator really still do whatever GeneratorFrontend does, just without writing files?)