Add definition for Embedder #12852
Add definition for Embedder #12852
Conversation
Summary of ChangesHello @sfshaza2, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses issue #12645 by enhancing the project's documentation. It introduces a new, detailed glossary entry for the term 'Embedder', providing clarity on its role as the platform-specific component managing the Flutter engine and its interactions with the operating system. This addition aims to improve understanding of Flutter's architecture for developers and readers. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new glossary entry for 'Embedder'. The definition is well-written and the provided links are relevant. I've suggested a minor update to the list of programming languages to improve technical accuracy and consistency with other documentation pages.
| It also manages the message event loop. | ||
| The embedder is written in a language appropriate for the platform, | ||
| such as Java/Kotlin for Android, Swift/Objective-C for iOS/macOS, |
There was a problem hiding this comment.
This is a great addition! For improved accuracy and consistency with the 'Flutter architectural overview' page, consider updating the list of languages. The overview page also mentions C++ for Android and Objective-C++ for iOS/macOS. Including them here would make the definition more complete and consistent.
such as Java/Kotlin and C++ for Android, Swift/Objective-C/Objective-C++ for iOS/macOS,
There was a problem hiding this comment.
This is factually correct, but I'd consider sweeping that under the rug.
The point the reader should takeaway here is that the Android embedder is the chunk of code that ports Flutter to Android, and is written in the language that's native for Android.
The Android embedder does use C++, but that's an implementation detail mainly to interoperate with the C++ Flutter engine. (Same story with iOS/macOS embedders using Objective-C++)
|
Visit the preview URL for this PR (updated for commit f430c1f): https://flutter-docs-prod--pr12852-glossary-embedder-lnweun58.web.app |
| The platform-specific component that coordinates with the operating system | ||
| and manages the Flutter engine. | ||
| long_description: |- | ||
| The _embedder_ provides the entrypoint for a Flutter app. |
There was a problem hiding this comment.
Strictly speaking, this is the runner app, not the embedder. I'd consider removing this sentence.
The runner app provides the native entry point for your Flutter project. It is responsible for launching Flutter.
Your Flutter project has a runner app for each platform, contained in the android/, ios/, linux/, macos, web, or windows directories.
The runner app's code is created when you run the flutter create command to create your Flutter project. However, you are free to modify the runner app as much as needed.
The runner app uses APIs exposed by the platform's embedder to launch the Flutter engine.
What do you think of something like this?
- term: "Embedder"
short_description: |-
The platform-specific component to support Flutter on a native platform.
long_description: |-
Each native platform supported by Flutter has an _embedder_ for
platform-specific logic.
The embedder is the bridge that coordinates with the underlying
operating system.
It implements services such as input, accessibility, message event loops,
and more.
The embedder also launches and manages the Flutter engine.
Each embedder is written in the platform's native language:
Java and Kotlin for Android, Swift and Objective-C for iOS and macOS,
and C++ for Windows and Linux.
Each embedder also expose plugin APIs.
These APIs let plugin packages add additional platform-specific
functionality to the app.
The embedder is launched and managed by the runner app.3 participants
Fixes #12645. Adds the glossary entry for 'Embedder' with relevant links.