Add synopsis for prebuilt_apis.

Test: m soong_docs
Change-Id: I0e2cefd3dd24e5c8483d32cc325a37e96d3d495c
This commit is contained in:
Jaewoong Jung
2019-03-21 10:48:25 -07:00
parent 53c88448fd
commit 5fb5b2a7f5

View File

@@ -22,13 +22,6 @@ import (
"github.com/google/blueprint/proptools"
)
// prebuilt_apis is a meta-module that generates filegroup modules for all
// API txt files found under the directory where the Android.bp is located.
// Specificaly, an API file located at ./<ver>/<scope>/api/<module>.txt
// generates a filegroup module named <module>-api.<scope>.<ver>.
//
// It also creates <module>-api.<scope>.latest for the lastest <ver>.
//
func init() {
android.RegisterModuleType("prebuilt_apis", PrebuiltApisFactory)
@@ -188,6 +181,12 @@ func PrebuiltApisMutator(mctx android.TopDownMutatorContext) {
}
}
// prebuilt_apis is a meta-module that generates filegroup modules for all
// API txt files found under the directory where the Android.bp is located.
// Specifically, an API file located at ./<ver>/<scope>/api/<module>.txt
// generates a filegroup module named <module>-api.<scope>.<ver>.
//
// It also creates <module>-api.<scope>.latest for the latest <ver>.
func PrebuiltApisFactory() android.Module {
module := &prebuiltApis{}
module.AddProperties(&module.properties)