[macOS] Revise the doc for FlutterViewController initializers #52242
Conversation
|
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 "@test-exemption-reviewer" in the #hackers channel in Chat (don't just cc them here, they won't see it! Use 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. |
| * This initializer is a shorthand for creating an engine explicitly and | ||
| * initializing with `initWithEngine:nibName:bundle:`. | ||
| * | ||
| * Since the created engine is only referred by this view controller, once thie |
There was a problem hiding this comment.
| * Since the created engine is only referred by this view controller, once thie | |
| * Since the created engine is only referred by this view controller, once the |
| * initializing with `initWithEngine:nibName:bundle:`. | ||
| * | ||
| * Since the created engine is only referred by this view controller, once thie | ||
| * view controller is deallocated, the engine will be shut down, unless anther |
There was a problem hiding this comment.
| * view controller is deallocated, the engine will be shut down, unless anther | |
| * view controller is deallocated, the engine will be shut down, unless another |
| @@ -84,13 +84,26 @@ FLUTTER_DARWIN_EXPORT | |||
| @property(nonatomic) FlutterMouseTrackingMode mouseTrackingMode; | |||
|
|
|||
| /** | |||
| * Initializes a controller that will run the given project. | |||
| * Initializes this `FlutterViewController` for the implicit view of a new | |||
| * `FlutterEngine`. | |||
There was a problem hiding this comment.
I prefer the original sentence here:
Initializes a controller that will run the given project.
I don't think we're ready yet to expose the implicit view to the user. This isn't something folks have needed to know about today. Could we punt this "implicit view" messaging until we're ready to migrate folks off the implicit view?
| * [PlatformDispatcher.implicitView](https://api.flutter.dev/flutter/dart-ui/PlatformDispatcher/implicitView.html). | ||
| * | ||
| * There isn't a way to create a `FlutterViewController` that's not attached | ||
| * to an engine. |
There was a problem hiding this comment.
Does this need to be on this doc? I would consider removing this.
This RP adds more details to the initializers.
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.