mapbox / mapbox/mapbox-navigation-android
UI module: remaining undocumented classes
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 651
- Forks
- 321
- PR merge metrics
- No merged PRs in 30d
Description
Starting with `dokka` 1.4+(https://github.com/mapbox/mapbox-navigation-android/pull/3757) we can track undocumented `java` classes.
#### List of undocumented java classes:
https://github.com/mapbox/mapbox-navigation-android/blob/5f5bf114d0baa283e23ac4f92429c2f6863f3ced/scripts/undocumented_classes.txt#L1-L53
#### How to trigger undocumented error:
- remove target class from the the list;
- from root of the project run terminal command: `./scripts/dokka-validate.sh`(undocumented classes locate into `libnavigation-ui` module so to speed-up script you can run one for particular module with flag `-m libnavigation-ui`)
- command output should be like `Undocumented: [TARGET CLASS/METHOD/FIELD]`.
**cc** @mapbox/navigation-android
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with scripts/undocumented_classes.txt and review the listed classes in the libnavigation-ui module. Run ./scripts/dokka-validate.sh -m libnavigation-ui to reproduce the undocumented-class output, then document the remaining listed classes until the validation reports no undocumented classes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, java
- Domain
- documentation, mobile
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100