apache / apache/cordova-docs

Issues with "Android Plugin Development Guide"

Open
#972 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
353
Forks
565
Avg merge
7h 15m
Merged PRs (30d)
5

Description

https://cordova.apache.org/docs/en/9.x/guide/platforms/android/plugin.html

- First paragraph includes "For another sample, see also the comments in CordovaPlugin.java." which is unclear what comments it refers to (at least to me)
- Refers twice to "Application Plugins" which is not clear what it refers to (not clickable, not a headline in this document)
- https://cordova.apache.org/docs/en/9.x/guide/platforms/android/plugin.html#plugin-class-mapping: From "Whether..." this is pretty unclear what it means
- should also probably include an example of "Java class's fully qualified namespace identifier" (possibly in the context of the sample Echo plugin)
- https://cordova.apache.org/docs/en/9.x/guide/platforms/android/plugin.html#echo-android-plugin-example later has a full example of this
- https://cordova.apache.org/docs/en/9.x/guide/platforms/android/plugin.html#writing-an-android-java-plugin
- What does "The JavaScript exec function's action parameter corresponds to a private class method to dispatch with optional parameters." mean?
- does this refer to a non-existing (in the example) private `beep` function?
- What does "When catching exceptions and returning errors, it's important for the sake of clarity that errors returned to JavaScript match Java's exception names as much as possible." mean? Example?
- https://cordova.apache.org/docs/en/9.x/guide/platforms/android/plugin.html#android-integration What can/should this be used for? Example?
- https://cordova.apache.org/docs/en/9.x/guide/platforms/android/plugin.html#android-permissions "until recently" to what? 2014?
- Does this need a headline "Install time permissions"?
- From how it is formulated right now I don't know if those still exist?
- https://cordova.apache.org/docs/en/9.x/guide/platforms/android/plugin.html#echo-android-plugin-example is places super awkward in the middle of other types of content

Contributor guide

Open the contributing guide

Research direction

Start with the Android Plugin Development Guide at the linked URL, reviewing the plugin class mapping, writing an Android Java plugin, Android integration, Android permissions, and Echo Android plugin example sections. Compare the references and explanations across those sections, then clarify the identified terminology, examples, and outdated wording and improve the Echo example’s placement.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java, javascript
Domain
documentation, mobile
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.