aboutsummaryrefslogtreecommitdiff
path: root/rules/aar_import/rule.bzl
diff options
context:
space:
mode:
Diffstat (limited to 'rules/aar_import/rule.bzl')
-rw-r--r--rules/aar_import/rule.bzl18
1 files changed, 17 insertions, 1 deletions
diff --git a/rules/aar_import/rule.bzl b/rules/aar_import/rule.bzl
index 02a1d61..3274c5d 100644
--- a/rules/aar_import/rule.bzl
+++ b/rules/aar_import/rule.bzl
@@ -17,15 +17,31 @@
load(":attrs.bzl", _ATTRS = "ATTRS")
load(":impl.bzl", _impl = "impl")
+RULE_DOC = """
+#### Examples
+
+The following example shows how to use `aar_import`.
+<pre><code>aar_import(
+ name = "hellobazellib",
+ aar = "lib.aar",
+ package = "bazel.hellobazellib",
+ deps = [
+ "//java/bazel/hellobazellib/activities",
+ "//java/bazel/hellobazellib/common",
+ ],
+)</code></pre>
+"""
+
aar_import = rule(
attrs = _ATTRS,
fragments = ["android"],
implementation = _impl,
+ doc = RULE_DOC,
provides = [
AndroidIdeInfo,
AndroidLibraryResourceClassJarProvider,
AndroidNativeLibsInfo,
JavaInfo,
],
- toolchains = ["@rules_android//toolchains/android:toolchain_type"],
+ toolchains = ["//toolchains/android:toolchain_type"],
)