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

Add doc comment to Pipeline #40388

Merged
merged 1 commit into from
Mar 17, 2023
Merged

Add doc comment to Pipeline #40388

merged 1 commit into from
Mar 17, 2023

Conversation

cbracken
Copy link
Member

Adds more detailed documentation to the Pipeline class. Also fixes a typo in fml::Semaphore docs.

No tests since this patch makes no semantic changes.

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.

@cbracken cbracken force-pushed the pipeline-doc branch 3 times, most recently from 00b36d5 to ac05992 Compare March 17, 2023 17:20
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

@cbracken cbracken force-pushed the pipeline-doc branch 2 times, most recently from 66aff63 to 1b581b0 Compare March 17, 2023 17:30
@cbracken cbracken force-pushed the pipeline-doc branch 2 times, most recently from f74902c to bdf8991 Compare March 17, 2023 17:42
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

The doc comment makes sense to me as someone not familiar with this pipeline 👍 .

It might not be worth addressing this in these docs, but after reading this I don't know why or where we might use this pipeline.

@cbracken
Copy link
Member Author

@justinmc at present (unless someone's added another use) there's actually only a single use of this pipeline, which is the LayerTree pipeline used in the animator/rasterizer. Agreed it would probably be a little clearer if we just hardcoded that in rather than having a generic type, though the generic type sure makes this a lot easier to test :)

I always feel a bit gross about adding "where this is used" type comments but given I don't see this changing anytime soon, maybe I should just add a breadcrumb.

Adds more detailed documentation to the Pipeline class. Also fixes a
typo in fml::Semaphore docs.
@cbracken
Copy link
Member Author

Done.

@justinmc
Copy link
Contributor

Sounds good. I agree about "where this is used" comments but the sentence you added seems pretty useful. Thanks!

@cbracken cbracken added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 17, 2023
@auto-submit auto-submit bot merged commit 2398c52 into flutter:main Mar 17, 2023
@cbracken cbracken deleted the pipeline-doc branch March 17, 2023 21:46
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 17, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 17, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 17, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 18, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 18, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 18, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 18, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 18, 2023
zanderso pushed a commit to flutter/flutter that referenced this pull request Mar 18, 2023
…122942)

* e6334f166 [web] Remove image codecs from Canvaskit Chromium (flutter/engine#40309)

* 56727d62c Revert "[Impeller] mark decoded images as optimized for GPU access (#40356)" (flutter/engine#40387)

* 2cd19e3d1 Wrap the iOS platform message handler in an autorelease pool block (flutter/engine#40373)

* bab7853ad Update analyzer for api_conform_test (flutter/engine#40386)

* 87b2e82d1 Roll Fuchsia Mac SDK from z32cF6YFs6CvZbY3g... to 4ZrEK2uzGdp_Gz3DU... (flutter/engine#40385)

* fc57995fe Ignore some MTLCompiler failures in impeller unit tests (flutter/engine#40391)

* 2398c5222 Add doc comment to Pipeline (flutter/engine#40388)

* f585d4bc5 [macOS] Remove a single accessibility root assumption (flutter/engine#40316)

* 940cf3c98 remove temporary flag and make FlutterTest the default font for real (flutter/engine#40352)

* a1bf9fd2a drawTextBlob should not be compatible with opacity inheritance (flutter/engine#40396)

* 55bf0d85e Use bundled analyzer everywhere (flutter/engine#40398)

* 8e580414a Roll Skia from 9bfb45d3e065 to 49b902e5fb91 (11 revisions) (flutter/engine#40397)

* 77c53d25e Default the CanvasKit base URL to local artifacts. (flutter/engine#40293)

* 625ea5395 Roll Skia from 49b902e5fb91 to aa983f5486f0 (7 revisions) (flutter/engine#40404)

* 867679fac [Impeller] Add playground flag to render for a specific amount of time. (flutter/engine#40377)

* d74169608 [Impeller] Remove unused bounds method from typographer interface (flutter/engine#40406)

* 941323d77 Provisional iOS impeller flag flip (flutter/engine#40405)

* bb971ab55 Revert "Default the CanvasKit base URL to local artifacts. (#40293)" (flutter/engine#40415)
zanderso pushed a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
autosubmit Merge PR when tree becomes green via auto submit App
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants