aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java
diff options
context:
space:
mode:
authorGravatar laurentlb <laurentlb@google.com>2017-07-17 15:47:20 +0200
committerGravatar Damien Martin-Guillerez <dmarting@google.com>2017-07-18 09:48:41 +0200
commit701ed8c31fe6d11b05d0d7d7c6b6d38ad04a1a2c (patch)
tree353ade865426d7bd6167e8d94736fa54dd04b466 /src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java
parentccfb2df69ecf4746f5a15e1295af995c3a45aa94 (diff)
Cleanup in Android/C++/Java providers documentation
RELNOTES: None. PiperOrigin-RevId: 162205838
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java
index edf6f2a08f..3a1f321bff 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java
@@ -41,7 +41,8 @@ import javax.annotation.Nullable;
category = SkylarkModuleCategory.PROVIDER,
doc =
"Provides access to information about Android rules. Every Android-related target provides "
- + "this struct, accessible as a 'android' field on a Target struct."
+ + "this struct, accessible as a <code>android</code> field on a "
+ + "<a href=\"Target.html\">target</a>."
)
@Immutable
public class AndroidSkylarkApiProvider extends SkylarkApiProvider {
@@ -98,9 +99,9 @@ public class AndroidSkylarkApiProvider extends SkylarkApiProvider {
name = "native_libs",
structField = true,
doc =
- "Returns the native libraries as a map of the libraries' architecture as a String to a "
- + "set of the native library artifacts, or the empty map if there are no native "
- + "libraries."
+ "Returns the native libraries as a dictionary of the libraries' architecture as a string "
+ + "to a set of the native library files, or the empty dictionary if there are no "
+ + "native libraries."
)
public ImmutableMap<String, NestedSet<Artifact>> getNativeLibs() {
return getIdeInfoProvider().getNativeLibs();
@@ -128,7 +129,7 @@ public class AndroidSkylarkApiProvider extends SkylarkApiProvider {
@SkylarkCallable(
name = "defines_resources",
structField = true,
- doc = "Returns true if the target defines any Android resources directly."
+ doc = "Returns <code>True</code> if the target defines any Android resources directly."
)
public boolean definesAndroidResources() {
return getIdeInfoProvider().definesAndroidResources();