1# Metalava usage by clients 2 3This doc lists out known usages of Metalava with specific features used by each user. The main users are Android 4platform and AndroidX libraries. 5 6## Features used by both androidx and Android platform 7- Signature generation of `*.txt` e.g. `current.txt` (`--api`) 8- API change compatibility checking of current API vs previous version txt (`--check-compatibility:api:released`) 9- API lint for compliance with [Android API guidelines](https://s.android.com/api-guidelines) (`--api-lint`) 10 11## Features used exclusively by androidx 12- Kotlin sources as inputs 13 14## Features used exclusively by Android platform 15- Support for partial signature files (opposite of `--show-unannotated`) where `@SystemApi` txt file omits public APIs 16- Java stubs for jar generation (`--stubs`) for generating android.jar, etc for SDK 17- Java stubs for docs generation (`--doc-stubs`) for passing to documentation tools 18- Documentation stub enhancement (`--enhance-documentation`) 19- Injecting `added in API level` into documentation stubs (`--apply-api-levels`) 20- Generating API levels information for documentation and SDK (`--generate-api-levels`) 21- Documentation rewriting for documentation stubs (`--replace-documentation`) used by libcore 22- Rewriting of nullness annotations to @RecentlyNull/NonNull (`--migrate-nullness`, 23`--force-convert-to-warning-nullability-annotations`) for SDK 24- Tracking @removed APIs (`--removed-api`) 25- DEX API signature generation (`--dex-api`) for for hidden API enforcement 26- XML API signature generation (`--api-xml`) for CTS tests and test coverage infrastructure 27- Annotation include, exclude, rewrite, passthrough in stubs (`--include-annotations`, `--exclude-all-annotations`, 28`--pass-through-annotation`, `--exclude-annotation`) 29- Annotation extraction (`--extract-annotations`, `--include-annotation-classes`, `--rewrite-annotations`, 30`--copy-annotations`, `--include-source-retention`) for generating SDK 31- Generating SDK metadata (`--sdk-`values`) 32