StrixOS/build_soong
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Output Javadoc comments for public API"

Browse Source
This commit is contained in:
Paul Duffin
2020-09-28 14:25:48 +00:00
committed by Gerrit Code Review
parent 79bee057a3 6877e6d951
commit d124b6b4e8
2 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
java/droiddoc.go
View File

@@ -253,6 +253,10 @@ type DroidstubsProperties struct {
// if set to true, allow Metalava to generate doc_stubs source files. Defaults to false. // if set to true, allow Metalava to generate doc_stubs source files. Defaults to false.
Create_doc_stubs *bool Create_doc_stubs *bool
// if set to true, cause Metalava to output Javadoc comments in the stubs source files. Defaults to false.
// Has no effect if create_doc_stubs: true.
Output_javadoc_comments *bool
// if set to false then do not write out stubs. Defaults to true. // if set to false then do not write out stubs. Defaults to true.
// //
// TODO(b/146727827): Remove capability when we do not need to generate stubs and API separately. // TODO(b/146727827): Remove capability when we do not need to generate stubs and API separately.
@@ -1150,9 +1154,11 @@ func (d *Droidstubs) stubsFlags(ctx android.ModuleContext, cmd *android.RuleBuil
cmd.FlagWithArg("--doc-stubs ", stubsDir.String()) cmd.FlagWithArg("--doc-stubs ", stubsDir.String())
} else { } else {
cmd.FlagWithArg("--stubs ", stubsDir.String()) cmd.FlagWithArg("--stubs ", stubsDir.String())
if !Bool(d.properties.Output_javadoc_comments) {
cmd.Flag("--exclude-documentation-from-stubs") cmd.Flag("--exclude-documentation-from-stubs")
} }
} }
}
} }
func (d *Droidstubs) annotationsFlags(ctx android.ModuleContext, cmd *android.RuleBuilderCommand) { func (d *Droidstubs) annotationsFlags(ctx android.ModuleContext, cmd *android.RuleBuilderCommand) {

6
java/sdk_library.go
View File

@@ -1203,6 +1203,7 @@ func (module *SdkLibrary) createStubsSourcesAndApi(mctx android.DefaultableHookC
Sdk_version *string Sdk_version *string
System_modules *string System_modules *string
Libs []string Libs []string
Output_javadoc_comments *bool
Arg_files []string Arg_files []string
Args *string Args *string
Java_version *string Java_version *string
@@ -1278,6 +1279,11 @@ func (module *SdkLibrary) createStubsSourcesAndApi(mctx android.DefaultableHookC
} }
droidstubsArgs = append(droidstubsArgs, android.JoinWithPrefix(disabledWarnings, "--hide ")) droidstubsArgs = append(droidstubsArgs, android.JoinWithPrefix(disabledWarnings, "--hide "))
// Output Javadoc comments for public scope.
if apiScope == apiScopePublic {
props.Output_javadoc_comments = proptools.BoolPtr(true)
}
// Add in scope specific arguments. // Add in scope specific arguments.
droidstubsArgs = append(droidstubsArgs, scopeSpecificDroidstubsArgs...) droidstubsArgs = append(droidstubsArgs, scopeSpecificDroidstubsArgs...)
props.Arg_files = module.sdkLibraryProperties.Droiddoc_option_files props.Arg_files = module.sdkLibraryProperties.Droiddoc_option_files