Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Move imageFormats template to instantiateImageCodec dartdoc #34948

Merged
auto-submit merged 2 commits into from
Jul 28, 2022
Merged

Move imageFormats template to instantiateImageCodec dartdoc #34948

auto-submit merged 2 commits into from
Jul 28, 2022

Conversation

@srawlins
Copy link
Contributor

@srawlins srawlins commented Jul 27, 2022 •
edited
Loading

Move the dart.ui.imageFormats template to instantiateImageCodec dartdoc. instantiateImageCodec is the first element whose dartdoc references dart.ui.imageFormats.

Fixes flutter/flutter#108476

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
  • I listed at least one issue that this PR fixes in the description above.
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt. See testing the engine for instructions on
    writing and running engine tests.
  • I updated/added relevant documentation (doc comments with ///).
  • I signed the CLA.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@flutter-dashboard
Copy link

flutter-dashboard bot commented Jul 27, 2022

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@srawlins
Copy link
Contributor Author

srawlins commented Jul 27, 2022

CC @goderbauer would you be someone to look at this, or do you know who could?

goderbauer
goderbauer reviewed Jul 27, 2022
View reviewed changes
lib/ui/painting.dart Outdated
// Update this list when changing the list of supported codecs.
/// {@template dart.ui.imageFormats}
/// JPEG, PNG, GIF, Animated GIF, WebP, Animated WebP, BMP, and WBMP. Additional
Copy link
Member

@goderbauer goderbauer Jul 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this not make this paragraph appear twice in the doc of instantiateImageCodec? Once here and another time above in line 2024 when the macro there gets expanded?

Copy link
Contributor Author

@srawlins srawlins Jul 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, don't you see how they're documented?

https://github.com/dart-lang/dartdoc/wiki/Doc-comment-directives#templates-and-macros

😛 I think you are correct though. Updated.

Copy link
Member

@goderbauer goderbauer Jul 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤣

goderbauer
goderbauer approved these changes Jul 27, 2022
View reviewed changes
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@srawlins
Copy link
Contributor Author

srawlins commented Jul 28, 2022

Do we need one more approval in this repo?

@goderbauer goderbauer added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 28, 2022
Piinks
Piinks approved these changes Jul 28, 2022
View reviewed changes
Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you!

@auto-submit auto-submit bot merged commit bbd18cb into flutter:main Jul 28, 2022
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 28, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 28, 2022
@engine-flutter-autoroll
bbd18cb Move imageFormats template to instantiateImageCodec dartdoc (f…
d92d27d 
…lutter/engine#34948)
@srawlins srawlins deleted the moveImageFormats branch July 28, 2022 22:03
betrevisan pushed a commit to betrevisan/engine that referenced this pull request Jul 29, 2022
@srawlins @betrevisan
Move imageFormats template to instantiateImageCodec dartdoc (flutter#…
0236eda 
…34948)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

2 more reviewers

@goderbauer goderbauer goderbauer approved these changes

@Piinks Piinks Piinks approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App needs tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Dartdoc macro template for dart.ui.imageFormats declare on a private element

3 participants

@srawlins @goderbauer @Piinks