| commit | ee390f26eb899a8044a663ba7309d6de78fbb717 | [log] [tgz] |
|---|---|---|
| author | Anton Hansson <hansson@google.com> | Thu Sep 16 15:26:49 2021 +0100 |
| committer | Anton Hansson <hansson@google.com> | Mon Sep 20 15:11:55 2021 +0100 |
| tree | 3e7214c91057085226e36dabaabae0b983806a96 | |
| parent | 9549fd75b91741b0aff21b1deb34b7579527031f [diff] |
Enhance documentation in mainline stubs Metalava has a feature to "enhance documentation" which is mostly based on auto-generating documentation text based on source-retention annotations. This is turned on automatically for doc stubs, but here we are enabling it for module's jar stubs as well. The point of this is to be able to replace the module source code with module jar stub source code when generating doc stubs -- something previously not possible because most source-retention annotations are not present in the jar stubs. In order for the enhancement to work properly, metalava needs to be passed the annotation source code rather than the annotations library. This is because of various javadoc tags controlling what documentation is generated, e.g. @paramDoc, @returnDoc etc. Bug: 186197911 Test: manually inspect module stub source code is enhanced Change-Id: I3fda4cd64e49c1da33fe614c30aafd9fa0dba3b9
This project includes mainline build and other utility code. Any library code intended for use by modules should go in frameworks/libs/modules-utils instead.
This project uses a single source path for java code. All java code should go in the java directory with subdirectories corresponding to the java package. Android.bp files should go alongside the java source files, and should only include java source for a single java package to encourage good code hygiene.
Tests for java code should go in the javatests directory and follow the same structure.