Overhaul example plugin, and rename it 'sample' #654
Merged
Conversation
This file contains 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
Having _plugin in the name made in inconsistent with all the actual plugins, making it harder to see how to adjust it to a real plugin name.
- Remove channel ivar, since it's not used in the example. - Add comments in the code for the things to change. - Remove most of the README in favor of pointing to the code comments, to make it easier to keep updated over time, and to reduce the need to look back and forth between two places while using the sample.
stuartmorgan
commented
Jan 29, 2020
| @@ -0,0 +1,41 @@ | |||
| # sample_plugin | |||
There was a problem hiding this comment.
This file is showing up as a new file rather than a modification of the old README because it both moved, and changed substantially due to moving a bunch of the specific instructions into comments in the code.
stuartmorgan
commented
Jan 29, 2020
| @@ -14,7 +14,7 @@ | |||
| <VCProjectVersion>15.0</VCProjectVersion> | |||
| <ProjectGuid>{95E21B2C-C18A-4CED-8509-585CB2570FDE}</ProjectGuid> | |||
| <Keyword>Win32Proj</Keyword> | |||
| <RootNamespace>example_plugin</RootNamespace> | |||
| <RootNamespace>dev_flutter_plugin</RootNamespace> | |||
There was a problem hiding this comment.
Since this isn't currently used by anything, I just gave it a generic value instead of the plugin name, since I think it's likely to not get updated by people, in practice, so long as it's unused and not surfaced anywhere.
stuartmorgan
commented
Jan 29, 2020
|
|
||
| ExamplePlugin::RegisterWithRegistrar(plugin_registrar); | ||
| } | ||
| // Copyright 2019 Google LLC |
There was a problem hiding this comment.
This file was using Windows line endings for some reason, unlike all our other code files, thus the everything-changed diff.
franciscojma86
approved these changes
Jan 29, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Renames the plugin from 'example_plugin' to 'sample' so that the naming is
consistent with all the actual plugins (which have 'plugin' in the class name,
but not the actual plugin name).
Also makes various improvements to the sample code and documentation,
as described in the associated bug.
Fixes #648