diff options
author | 2016-12-13 04:03:26 +0000 | |
---|---|---|
committer | 2016-12-13 16:30:36 +0000 | |
commit | efb14117127789c0b0bc4670d4a92a44fbb3b4e4 (patch) | |
tree | 24fc013be8a5e8654c4a2d39b6895eef18e7ded2 | |
parent | bf9bbe7d1c4f2135af342e862c795fad8f840a88 (diff) |
Document aar_import in Bazel.
Fixes https://github.com/bazelbuild/bazel/issues/564.
RELNOTES: aar_import rule is now documented.
--
PiperOrigin-RevId: 141843994
MOS_MIGRATED_REVID=141843994
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/bazel/rules/android/BazelAarImportRule.java | 26 | ||||
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/rules/android/AarImportBaseRule.java | 8 |
2 files changed, 33 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/android/BazelAarImportRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/android/BazelAarImportRule.java index fc64a5c968..d55bf7a600 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/android/BazelAarImportRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/android/BazelAarImportRule.java @@ -40,3 +40,29 @@ public final class BazelAarImportRule implements RuleDefinition { .build(); } } + +/*<!-- #BLAZE_RULE (NAME = aar_import, TYPE = LIBRARY, FAMILY = Android) --> + +<p> + This rule allows the use of <code>.aar</code> files as libraries for + <code><a href="${link android_library}">android_library</a></code> and + <code><a href="${link android_binary}">android_binary</a></code> rules. +</p> + +<h4 id="aar_import_examples">Examples</h4> + +<pre class="code"> + aar_import( + name = "google-vr-sdk", + aar = "gvr-android-sdk/libraries/sdk-common-1.10.0.aar", + ) + + android_binary( + name = "app", + manifest = "AndroidManifest.xml", + srcs = glob(["**.java"]), + deps = [":google-vr-sdk"], + ) +</pre> + +<!-- #END_BLAZE_RULE -->*/ diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AarImportBaseRule.java b/src/main/java/com/google/devtools/build/lib/rules/android/AarImportBaseRule.java index 1e9e28c457..6abf8ed35e 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AarImportBaseRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AarImportBaseRule.java @@ -35,10 +35,16 @@ public class AarImportBaseRule implements RuleDefinition { @Override public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) { return builder - .setUndocumented() + /* <!-- #BLAZE_RULE($aar_import_base).ATTRIBUTE(aar) --> + The <code>.aar</code> file to provide to the Android targets that depend on this target. + <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("aar", LABEL) .mandatory() .allowedFileTypes(FileType.of(".aar"))) + /* <!-- #BLAZE_RULE(aar_import).ATTRIBUTE(exports) --> + Target to export to rules that depend on this rule. + See <a href="${link java_library.exports}">java_library.exports. + <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("exports", LABEL_LIST) .allowedRuleClasses("aar_import", "java_import") .allowedFileTypes() |