Merge "Hide some noisy Metalava issues" into main

This commit is contained in:
Paul Duffin 2024-06-10 19:47:31 +00:00 committed by Gerrit Code Review
commit ccad8ff606

View file

@ -1054,8 +1054,7 @@ func (d *Droidstubs) everythingOptionalCmd(ctx android.ModuleContext, cmd *andro
} }
if !treatDocumentationIssuesAsErrors { if !treatDocumentationIssuesAsErrors {
// Treat documentation issues as warnings, but error when new. treatDocumentationIssuesAsWarningErrorWhenNew(cmd)
cmd.Flag("--error-when-new-category").Flag("Documentation")
} }
// Add "check released" options. (Detect incompatible API changes from the last public release) // Add "check released" options. (Detect incompatible API changes from the last public release)
@ -1083,6 +1082,22 @@ func (d *Droidstubs) everythingOptionalCmd(ctx android.ModuleContext, cmd *andro
} }
} }
// HIDDEN_DOCUMENTATION_ISSUES is the set of documentation related issues that should always be
// hidden as they are very noisy and provide little value.
var HIDDEN_DOCUMENTATION_ISSUES = []string{
"Deprecated",
"IntDef",
"Nullable",
}
func treatDocumentationIssuesAsWarningErrorWhenNew(cmd *android.RuleBuilderCommand) {
// Treat documentation issues as warnings, but error when new.
cmd.Flag("--error-when-new-category").Flag("Documentation")
// Hide some documentation issues that generated a lot of noise for little benefit.
cmd.FlagForEachArg("--hide ", HIDDEN_DOCUMENTATION_ISSUES)
}
// Sandbox rule for generating exportable stubs and other artifacts // Sandbox rule for generating exportable stubs and other artifacts
func (d *Droidstubs) exportableStubCmd(ctx android.ModuleContext, params stubsCommandConfigParams) { func (d *Droidstubs) exportableStubCmd(ctx android.ModuleContext, params stubsCommandConfigParams) {
optionalCmdParams := stubsCommandParams{ optionalCmdParams := stubsCommandParams{
@ -1154,7 +1169,7 @@ func (d *Droidstubs) optionalStubCmd(ctx android.ModuleContext, params stubsComm
} }
// Treat documentation issues as warnings, but error when new. // Treat documentation issues as warnings, but error when new.
cmd.Flag("--error-when-new-category").Flag("Documentation") treatDocumentationIssuesAsWarningErrorWhenNew(cmd)
if params.stubConfig.generateStubs { if params.stubConfig.generateStubs {
rule.Command(). rule.Command().