diff --git a/docs/rules.md b/docs/rules.md index 3a4dda3..e92ecad 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -1,16 +1,56 @@ -Public API re-exports - -## example + + +## android_lint_test + +
+android_lint_test(name, autofix, baseline, config, custom_rules, deps, disable_checks, + enable_checks, is_test_sources, manifest, resource_files, self, srcs, + warnings_as_errors) ++ + + +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| name | A unique name for this target. | Name | required | | +| autofix | Enables lint autofix | Boolean | optional |
False
|
+| baseline | Lint baseline file. | Label | optional | None
|
+| config | Lint configuration file. | Label | optional | None
|
+| custom_rules | Custom lint rules to run. | List of labels | optional | []
|
+| deps | Dependencies that should be on the classpath during execution. | List of labels | optional | []
|
+| disable_checks | List of checks to disable. | List of strings | optional | []
|
+| enable_checks | List of checks to enable. | List of strings | optional | []
|
+| is_test_sources | True when linting test sources, otherwise false. | Boolean | optional | False
|
+| manifest | Android manifest to run Android Lint against. | Label | optional | None
|
+| resource_files | Android resource files to run Android Lint against. | List of labels | optional | []
|
+| self | The target being linted. | Label | required | |
+| srcs | Sources to run Android Lint against. | List of labels | required | |
+| warnings_as_errors | When true, lint will treat warnings as errors. | Boolean | optional | False
|
+
+
+
+
+## AndroidLintResultsInfo
-example() +AndroidLintResultsInfo(output, project_configuration)-This is an example +Info needed to evaluate lint results + +**FIELDS** + +| Name | Description | +| :------------- | :------------- | +| output | The Android Lint baseline output | +| project_configuration | The Android Lint output configuration file |